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

package/src/payment-flow-handlers/handlers/venmo-flow-handler.ts

@@ -1,118 +1,118 @@
-import { BraintreeManagerInterface } from '../../braintree-manager/braintree-interfaces';
-import {
-  DonorContactInfo,
-  DonationPaymentInfo,
-  PaymentProvider,
-} from '@internetarchive/donation-form-data-models';
-import {
-  VenmoRestorationStateHandlerInterface,
-  VenmoRestorationStateHandler,
-} from './venmo-restoration-state-handler';
-import { DonationFlowModalManagerInterface } from '../donation-flow-modal-manager';
-
-export interface VenmoFlowHandlerInterface {
-  startup(): Promise<void>;
-  paymentInitiated(contactInfo: DonorContactInfo, donationInfo: DonationPaymentInfo): Promise<void>;
-}
-
-export class VenmoFlowHandler implements VenmoFlowHandlerInterface {
-  private donationFlowModalManager: DonationFlowModalManagerInterface;
-
-  private braintreeManager: BraintreeManagerInterface;
-
-  private restorationStateHandler: VenmoRestorationStateHandlerInterface;
-
-  constructor(options: {
-    braintreeManager: BraintreeManagerInterface;
-    donationFlowModalManager: DonationFlowModalManagerInterface;
-    restorationStateHandler?: VenmoRestorationStateHandlerInterface;
-  }) {
-    this.braintreeManager = options.braintreeManager;
-    this.donationFlowModalManager = options.donationFlowModalManager;
-    this.restorationStateHandler =
-      options.restorationStateHandler ?? new VenmoRestorationStateHandler();
-  }
-
-  /**
-   * Check if we have any results from Venmo on startup.
-   *
-   * This happens if the app redirects to us in a new tab so we can resume the session.
-   *
-   * @returns {Promise<void>}
-   * @memberof VenmoFlowHandler
-   */
-  async startup(): Promise<void> {
-    const handler = await this.braintreeManager.paymentProviders.venmoHandler.get();
-    const instance = await handler?.instance.get();
-    if (instance?.hasTokenizationResult()) {
-      // if we get redirected back from venmo in a different tab, we need to restore the data
-      // that was persisted when the payment was initiated
-      const restoredInfo = await this.restorationStateHandler.getRestorationState();
-      if (restoredInfo) {
-        this.paymentInitiated(restoredInfo.contactInfo, restoredInfo.donationInfo);
-      } else {
-        console.error('no restoration info');
-        this.donationFlowModalManager.showErrorModal({
-          message: 'Error restoring donation session',
-        });
-      }
-    }
-  }
-
-  // VenmoFlowHandlerInterface conformance
-  async paymentInitiated(
-    contactInfo: DonorContactInfo,
-    donationInfo: DonationPaymentInfo,
-  ): Promise<void> {
-    // if we get redirected back from venmo in a different tab, we need to restore the data
-    // that was persisted when the payment was initiated so persist it here
-    this.restorationStateHandler.persistState(contactInfo, donationInfo);
-
-    try {
-      const handler = await this.braintreeManager.paymentProviders.venmoHandler.get();
-      const result = await handler?.startPayment();
-      if (!result) {
-        this.restorationStateHandler.clearState();
-        this.donationFlowModalManager.showErrorModal({
-          message: 'Error setting up the donation',
-        });
-        return;
-      }
-      this.handleTokenizationResult(result, contactInfo, donationInfo);
-    } catch (tokenizeError) {
-      this.restorationStateHandler.clearState();
-      this.handleTokenizationError(tokenizeError);
-      this.donationFlowModalManager.showErrorModal({
-        message: `There was a problem loading your donation information. Please try again.`,
-      });
-    }
-  }
-
-  private async handleTokenizationResult(
-    payload: braintree.VenmoTokenizePayload,
-    contactInfo: DonorContactInfo,
-    donationInfo: DonationPaymentInfo,
-  ): Promise<void> {
-    this.restorationStateHandler.clearState();
-
-    this.donationFlowModalManager.startDonationSubmissionFlow({
-      nonce: payload.nonce,
-      paymentProvider: PaymentProvider.Venmo,
-      donationInfo: donationInfo,
-      customerInfo: contactInfo.customer,
-      billingInfo: contactInfo.billing,
-    });
-  }
-
-  private handleTokenizationError(tokenizeError: braintree.BraintreeError): void {
-    // Handle flow errors or premature flow closure
-    switch (tokenizeError.code) {
-      case 'VENMO_APP_CANCELED':
-        break;
-      case 'VENMO_CANCELED':
-        break;
-      default:
-        console.error('Error!', tokenizeError);
-    }
-  }
-}
+import { BraintreeManagerInterface } from '../../braintree-manager/braintree-interfaces';
+import {
+  DonorContactInfo,
+  DonationPaymentInfo,
+  PaymentProvider,
+} from '@internetarchive/donation-form-data-models';
+import {
+  VenmoRestorationStateHandlerInterface,
+  VenmoRestorationStateHandler,
+} from './venmo-restoration-state-handler';
+import { DonationFlowModalManagerInterface } from '../donation-flow-modal-manager';
+
+export interface VenmoFlowHandlerInterface {
+  startup(): Promise<void>;
+  paymentInitiated(contactInfo: DonorContactInfo, donationInfo: DonationPaymentInfo): Promise<void>;
+}
+
+export class VenmoFlowHandler implements VenmoFlowHandlerInterface {
+  private donationFlowModalManager: DonationFlowModalManagerInterface;
+
+  private braintreeManager: BraintreeManagerInterface;
+
+  private restorationStateHandler: VenmoRestorationStateHandlerInterface;
+
+  constructor(options: {
+    braintreeManager: BraintreeManagerInterface;
+    donationFlowModalManager: DonationFlowModalManagerInterface;
+    restorationStateHandler?: VenmoRestorationStateHandlerInterface;
+  }) {
+    this.braintreeManager = options.braintreeManager;
+    this.donationFlowModalManager = options.donationFlowModalManager;
+    this.restorationStateHandler =
+      options.restorationStateHandler ?? new VenmoRestorationStateHandler();
+  }
+
+  /**
+   * Check if we have any results from Venmo on startup.
+   *
+   * This happens if the app redirects to us in a new tab so we can resume the session.
+   *
+   * @returns {Promise<void>}
+   * @memberof VenmoFlowHandler
+   */
+  async startup(): Promise<void> {
+    const handler = await this.braintreeManager.paymentProviders.venmoHandler.get();
+    const instance = await handler?.instance.get();
+    if (instance?.hasTokenizationResult()) {
+      // if we get redirected back from venmo in a different tab, we need to restore the data
+      // that was persisted when the payment was initiated
+      const restoredInfo = await this.restorationStateHandler.getRestorationState();
+      if (restoredInfo) {
+        this.paymentInitiated(restoredInfo.contactInfo, restoredInfo.donationInfo);
+      } else {
+        console.error('no restoration info');
+        this.donationFlowModalManager.showErrorModal({
+          message: 'Error restoring donation session',
+        });
+      }
+    }
+  }
+
+  // VenmoFlowHandlerInterface conformance
+  async paymentInitiated(
+    contactInfo: DonorContactInfo,
+    donationInfo: DonationPaymentInfo,
+  ): Promise<void> {
+    // if we get redirected back from venmo in a different tab, we need to restore the data
+    // that was persisted when the payment was initiated so persist it here
+    this.restorationStateHandler.persistState(contactInfo, donationInfo);
+
+    try {
+      const handler = await this.braintreeManager.paymentProviders.venmoHandler.get();
+      const result = await handler?.startPayment();
+      if (!result) {
+        this.restorationStateHandler.clearState();
+        this.donationFlowModalManager.showErrorModal({
+          message: 'Error setting up the donation',
+        });
+        return;
+      }
+      this.handleTokenizationResult(result, contactInfo, donationInfo);
+    } catch (tokenizeError) {
+      this.restorationStateHandler.clearState();
+      this.handleTokenizationError(tokenizeError);
+      this.donationFlowModalManager.showErrorModal({
+        message: `There was a problem loading your donation information. Please try again.`,
+      });
+    }
+  }
+
+  private async handleTokenizationResult(
+    payload: braintree.VenmoTokenizePayload,
+    contactInfo: DonorContactInfo,
+    donationInfo: DonationPaymentInfo,
+  ): Promise<void> {
+    this.restorationStateHandler.clearState();
+
+    this.donationFlowModalManager.startDonationSubmissionFlow({
+      nonce: payload.nonce,
+      paymentProvider: PaymentProvider.Venmo,
+      donationInfo: donationInfo,
+      customerInfo: contactInfo.customer,
+      billingInfo: contactInfo.billing,
+    });
+  }
+
+  private handleTokenizationError(tokenizeError: braintree.BraintreeError): void {
+    // Handle flow errors or premature flow closure
+    switch (tokenizeError.code) {
+      case 'VENMO_APP_CANCELED':
+        break;
+      case 'VENMO_CANCELED':
+        break;
+      default:
+        console.error('Error!', tokenizeError);
+    }
+  }
+}

package/src/payment-flow-handlers/handlers/venmo-restoration-state-handler.ts

@@ -1,127 +1,127 @@
-import { DonorContactInfo, DonationPaymentInfo } from '@internetarchive/donation-form-data-models';
-
-export interface VenmoRestorationStateHandlerInterface {
-  /**
-   * Persist the session state
-   *
-   * @param {DonorContactInfo} contactInfo
-   * @param {DonationPaymentInfo} donationInfo
-   * @memberof VenmoRestorationStateHandlerInterface
-   */
-  persistState(contactInfo: DonorContactInfo, donationInfo: DonationPaymentInfo): void;
-
-  /**
-   * Get the session restoration state
-   *
-   * @returns {(Promise<VenmoRestorationState | undefined>)}
-   * @memberof VenmoRestorationStateHandlerInterface
-   */
-  getRestorationState(): Promise<VenmoRestorationState | undefined>;
-
-  /**
-   * Clear the restoration state
-   *
-   * @memberof VenmoRestorationStateHandlerInterface
-   */
-  clearState(): void;
-}
-
-/**
- * Structure to store the session restoration state
- *
- * @export
- * @class VenmoRestorationState
- */
-export class VenmoRestorationState {
-  contactInfo: DonorContactInfo;
-  donationInfo: DonationPaymentInfo;
-
-  // TODO: Add restoration state expiration
-  constructor(params: { contactInfo: DonorContactInfo; donationInfo: DonationPaymentInfo }) {
-    this.contactInfo = params.contactInfo;
-    this.donationInfo = params.donationInfo;
-  }
-}
-
-/**
- * The VenmoRestorationStateHandler is used to persist and restore a Venmo checkout session.
- *
- * Venmo takes the user out of the web browser and into their app to authorize the purchase.
- * It then redirects the user back to the website to finish the transaction. The problem is
- * it may open a new browser tab so it's like starting a new session. We need to persist
- * the session information from the start of the Venmo session and restore it when it resumes.
- *
- * This class stores the session information in localStorage when the Venmo session is started
- * and retrieves it when the session is restored.
- *
- * @export
- * @class VenmoRestorationStateHandler
- * @implements {VenmoRestorationStateHandlerInterface}
- */
-export class VenmoRestorationStateHandler implements VenmoRestorationStateHandlerInterface {
-  private persistanceKey = 'venmoRestorationStateInfo';
-
-  private storageSystem?: Storage;
-
-  constructor(options?: { storageSystem?: Storage }) {
-    if (options?.storageSystem) {
-      this.storageSystem = options.storageSystem;
-    } else if (this.storageSystemAvailable(localStorage)) {
-      this.storageSystem = localStorage;
-    } else if (this.storageSystemAvailable(sessionStorage)) {
-      this.storageSystem = sessionStorage;
-    }
-  }
-
-  /** @inheritdoc */
-  clearState(): void {
-    this.storageSystem?.removeItem(this.persistanceKey);
-  }
-
-  /** @inheritdoc */
-  persistState(contactInfo: DonorContactInfo, donationInfo: DonationPaymentInfo): void {
-    const venmoRestoration = new VenmoRestorationState({
-      contactInfo,
-      donationInfo,
-    });
-    const serialized = JSON.stringify(venmoRestoration);
-    this.storageSystem?.setItem(this.persistanceKey, serialized);
-  }
-
-  /** @inheritdoc */
-  async getRestorationState(): Promise<VenmoRestorationState | undefined> {
-    const stored = this.storageSystem?.getItem(this.persistanceKey);
-    if (!stored) {
-      console.error('restoreState: No stored data');
-      return undefined;
-    }
-
-    const deserialized = JSON.parse(stored);
-    if (!deserialized) {
-      console.error('restoreState: Data could not be deserialized');
-      return undefined;
-    }
-
-    const donationInfo = new VenmoRestorationState(deserialized);
-
-    return donationInfo;
-  }
-
-  /**
-   * Check if a particular storage system (localStorage/sessionStorage) is availble
-   *
-   * @private
-   * @param {Storage} system
-   * @returns {boolean}
-   * @memberof VenmoRestorationStateHandler
-   */
-  private storageSystemAvailable(system: Storage): boolean {
-    try {
-      system.setItem('foo', 'bar');
-      system.removeItem('foo');
-      return true;
-    } catch (exception) {
-      return false;
-    }
-  }
-}
+import { DonorContactInfo, DonationPaymentInfo } from '@internetarchive/donation-form-data-models';
+
+export interface VenmoRestorationStateHandlerInterface {
+  /**
+   * Persist the session state
+   *
+   * @param {DonorContactInfo} contactInfo
+   * @param {DonationPaymentInfo} donationInfo
+   * @memberof VenmoRestorationStateHandlerInterface
+   */
+  persistState(contactInfo: DonorContactInfo, donationInfo: DonationPaymentInfo): void;
+
+  /**
+   * Get the session restoration state
+   *
+   * @returns {(Promise<VenmoRestorationState | undefined>)}
+   * @memberof VenmoRestorationStateHandlerInterface
+   */
+  getRestorationState(): Promise<VenmoRestorationState | undefined>;
+
+  /**
+   * Clear the restoration state
+   *
+   * @memberof VenmoRestorationStateHandlerInterface
+   */
+  clearState(): void;
+}
+
+/**
+ * Structure to store the session restoration state
+ *
+ * @export
+ * @class VenmoRestorationState
+ */
+export class VenmoRestorationState {
+  contactInfo: DonorContactInfo;
+  donationInfo: DonationPaymentInfo;
+
+  // TODO: Add restoration state expiration
+  constructor(params: { contactInfo: DonorContactInfo; donationInfo: DonationPaymentInfo }) {
+    this.contactInfo = params.contactInfo;
+    this.donationInfo = params.donationInfo;
+  }
+}
+
+/**
+ * The VenmoRestorationStateHandler is used to persist and restore a Venmo checkout session.
+ *
+ * Venmo takes the user out of the web browser and into their app to authorize the purchase.
+ * It then redirects the user back to the website to finish the transaction. The problem is
+ * it may open a new browser tab so it's like starting a new session. We need to persist
+ * the session information from the start of the Venmo session and restore it when it resumes.
+ *
+ * This class stores the session information in localStorage when the Venmo session is started
+ * and retrieves it when the session is restored.
+ *
+ * @export
+ * @class VenmoRestorationStateHandler
+ * @implements {VenmoRestorationStateHandlerInterface}
+ */
+export class VenmoRestorationStateHandler implements VenmoRestorationStateHandlerInterface {
+  private persistanceKey = 'venmoRestorationStateInfo';
+
+  private storageSystem?: Storage;
+
+  constructor(options?: { storageSystem?: Storage }) {
+    if (options?.storageSystem) {
+      this.storageSystem = options.storageSystem;
+    } else if (this.storageSystemAvailable(localStorage)) {
+      this.storageSystem = localStorage;
+    } else if (this.storageSystemAvailable(sessionStorage)) {
+      this.storageSystem = sessionStorage;
+    }
+  }
+
+  /** @inheritdoc */
+  clearState(): void {
+    this.storageSystem?.removeItem(this.persistanceKey);
+  }
+
+  /** @inheritdoc */
+  persistState(contactInfo: DonorContactInfo, donationInfo: DonationPaymentInfo): void {
+    const venmoRestoration = new VenmoRestorationState({
+      contactInfo,
+      donationInfo,
+    });
+    const serialized = JSON.stringify(venmoRestoration);
+    this.storageSystem?.setItem(this.persistanceKey, serialized);
+  }
+
+  /** @inheritdoc */
+  async getRestorationState(): Promise<VenmoRestorationState | undefined> {
+    const stored = this.storageSystem?.getItem(this.persistanceKey);
+    if (!stored) {
+      console.error('restoreState: No stored data');
+      return undefined;
+    }
+
+    const deserialized = JSON.parse(stored);
+    if (!deserialized) {
+      console.error('restoreState: Data could not be deserialized');
+      return undefined;
+    }
+
+    const donationInfo = new VenmoRestorationState(deserialized);
+
+    return donationInfo;
+  }
+
+  /**
+   * Check if a particular storage system (localStorage/sessionStorage) is availble
+   *
+   * @private
+   * @param {Storage} system
+   * @returns {boolean}
+   * @memberof VenmoRestorationStateHandler
+   */
+  private storageSystemAvailable(system: Storage): boolean {
+    try {
+      system.setItem('foo', 'bar');
+      system.removeItem('foo');
+      return true;
+    } catch (exception) {
+      return false;
+    }
+  }
+}