@connexup/react-native-square-mobile-payment-sdk 0.1.0

package/src/reader/index.ts

@@ -0,0 +1,140 @@
+import type { EventSubscription } from 'react-native';
+import {
+  createMobilePaymentError,
+  createMobilePaymentErrorFromCallback,
+} from '../util';
+import type {
+  PairingStatusChangeEvent,
+  PairingStatusListener,
+  ReaderInfo,
+  ReaderListener,
+  Spec,
+} from './NativeMobilePaymentReader';
+import { NativeMobilePaymentReader } from './NativeMobilePaymentReader';
+
+class MobilePaymentReader
+  implements
+    Omit<Spec, 'getConstants' | 'onReaderChange' | 'onReaderPairingStatus'>
+{
+  private readonly readerManage: Spec;
+  private pairingSubscription?: EventSubscription | null;
+
+  constructor(readerManage: Spec) {
+    this.readerManage = readerManage;
+  }
+
+  async bink(readerId: string): Promise<void> {
+    try {
+      return await this.readerManage.bink(readerId);
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async forget(readerId: string): Promise<void> {
+    try {
+      return await this.readerManage.forget(readerId);
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  readers(): ReaderInfo[] {
+    try {
+      return this.readerManage.readers();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async retryConnection(readerId: string): Promise<void> {
+    try {
+      return await this.readerManage.retryConnection(readerId);
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async startPairing(listener?: PairingStatusListener): Promise<void> {
+    this.pairingSubscription?.remove();
+    this.pairingSubscription = null;
+    if (listener) {
+      this.pairingSubscription = this.addPairingStatusListener(listener);
+    }
+    try {
+      return await this.readerManage.startPairing();
+    } catch (e) {
+      this.pairingSubscription?.remove();
+      this.pairingSubscription = null;
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async stopPairing(): Promise<boolean> {
+    try {
+      return await this.readerManage.stopPairing();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  isPairingInProgress(): boolean {
+    try {
+      return this.readerManage.isPairingInProgress();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  addReaderListener(listener: ReaderListener): EventSubscription {
+    return this.readerManage.onReaderChange((event) => {
+      switch (event.name) {
+        case 'readerWasAdded':
+          if (listener.readerWasAdded) {
+            listener.readerWasAdded(event.readerInfo);
+          }
+          break;
+        case 'readerWasRemoved':
+          if (listener.readerWasRemoved) {
+            listener.readerWasRemoved(event.readerInfo);
+          }
+          break;
+        case 'readerDidChange':
+          if (listener.readerDidChange) {
+            listener.readerDidChange(event.readerInfo, event.readerChange!);
+          }
+          break;
+      }
+    });
+  }
+
+  addPairingStatusListener(listener: PairingStatusListener): EventSubscription {
+    return this.readerManage.onReaderPairingStatus(
+      (event: PairingStatusChangeEvent) => {
+        switch (event.name) {
+          case 'didBegin':
+            if (listener.didBegin) {
+              listener.didBegin();
+            }
+            break;
+          case 'didSucceed':
+            if (listener.didSucceed) {
+              listener.didSucceed();
+            }
+            break;
+          case 'didFail':
+            if (listener.didFail) {
+              listener.didFail(
+                createMobilePaymentErrorFromCallback(event.error)
+              );
+            }
+            break;
+        }
+      }
+    );
+  }
+}
+
+export const mobilePaymentReader = new MobilePaymentReader(
+  NativeMobilePaymentReader
+);

package/src/setting/NativeMobilePaymentSetting.ts

@@ -0,0 +1,254 @@
+import { type TurboModule, TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+  initialize(applicationId: string): Promise<boolean>;
+
+  applicationId(): string | null;
+
+  sdkSettings(): SdkSettings;
+
+  paymentSettings(): PaymentSettings;
+
+  trackingConsentState(): TrackingConsentState;
+
+  updateTrackingConsent(granted: boolean): Promise<void>;
+
+  presentSettings(): Promise<void>;
+
+  //only sandbox
+  presentMockReaderUI(): Promise<void>;
+
+  dismissMockReaderUI(): Promise<void>;
+}
+
+export const NativeMobilePaymentSetting =
+  TurboModuleRegistry.getEnforcing<Spec>('NativeMobilePaymentSetting');
+
+export type TrackingConsentState =
+  | 'PENDING'
+  | 'GRANTED'
+  | 'DENIED'
+  | 'NOT_REQUIRED'
+  | 'UNKNOWN';
+
+export interface SdkSettings {
+  environment: 'PRODUCTION' | 'SANDBOX' | 'UNKNOWN';
+  version: string;
+}
+
+export interface PaymentSettings {
+  /**
+   * Whether taking payments offline is allowed for the current seller.
+   */
+  isOfflineProcessingAllowed: boolean;
+
+  /**
+   * The maximum transaction amount that can be processed in a single offline payment.
+   * A payment that exceeds this limit will be ineligible for offline processing.
+   * This will be <code>nil</code> if offline processing is not allowed.
+   */
+  offlineTransactionAmountLimit: Money | null;
+  /**
+   * The total allowable amount of all offline payments combined on this device.
+   * A payment that would exceed the total limit will be ineligible for offline processing.
+   * This will be null if offline processing is not allowed.
+   */
+  offlineTotalStoredAmountLimit: Money | null;
+}
+
+export interface Money {
+  /**
+   * The amount of money in the smallest denomination of the currency.
+   * For example, when currency is .usd, the amount is in cents.
+   */
+  amount: number;
+  /**
+   * The currency code.
+   */
+  currency: Currency;
+}
+
+export type Currency =
+  | 'AUD'
+  | 'CAD'
+  | 'EUR'
+  | 'GBP'
+  | 'JPY'
+  | 'USD'
+  | 'AED'
+  | 'AFN'
+  | 'ALL'
+  | 'AMD'
+  | 'ANG'
+  | 'AOA'
+  | 'ARS'
+  | 'AWG'
+  | 'AZN'
+  | 'BAM'
+  | 'BBD'
+  | 'BDT'
+  | 'BGN'
+  | 'BHD'
+  | 'BIF'
+  | 'BMD'
+  | 'BND'
+  | 'BOB'
+  | 'BOV'
+  | 'BRL'
+  | 'BSD'
+  | 'BTN'
+  | 'BWP'
+  | 'BYR'
+  | 'BZD'
+  | 'CDF'
+  | 'CHE'
+  | 'CHF'
+  | 'CHW'
+  | 'CLF'
+  | 'CLP'
+  | 'CNY'
+  | 'COP'
+  | 'COU'
+  | 'CRC'
+  | 'CUC'
+  | 'CUP'
+  | 'CVE'
+  | 'CZK'
+  | 'DJF'
+  | 'DKK'
+  | 'DOP'
+  | 'DZD'
+  | 'EGP'
+  | 'ERN'
+  | 'ETB'
+  | 'FJD'
+  | 'FKP'
+  | 'GEL'
+  | 'GHS'
+  | 'GIP'
+  | 'GMD'
+  | 'GNF'
+  | 'GTQ'
+  | 'GYD'
+  | 'HKD'
+  | 'HNL'
+  | 'HRK'
+  | 'HTG'
+  | 'HUF'
+  | 'IDR'
+  | 'ILS'
+  | 'INR'
+  | 'IQD'
+  | 'IRR'
+  | 'ISK'
+  | 'JMD'
+  | 'JOD'
+  | 'KES'
+  | 'KGS'
+  | 'KHR'
+  | 'KMF'
+  | 'KPW'
+  | 'KRW'
+  | 'KWD'
+  | 'KYD'
+  | 'KZT'
+  | 'LAK'
+  | 'LBP'
+  | 'LKR'
+  | 'LRD'
+  | 'LSL'
+  | 'LTL'
+  | 'LVL'
+  | 'LYD'
+  | 'MAD'
+  | 'MDL'
+  | 'MGA'
+  | 'MKD'
+  | 'MMK'
+  | 'MNT'
+  | 'MOP'
+  | 'MRO'
+  | 'MUR'
+  | 'MVR'
+  | 'MWK'
+  | 'MXN'
+  | 'MXV'
+  | 'MYR'
+  | 'MZN'
+  | 'NAD'
+  | 'NGN'
+  | 'NIO'
+  | 'NOK'
+  | 'NPR'
+  | 'NZD'
+  | 'OMR'
+  | 'PAB'
+  | 'PEN'
+  | 'PGK'
+  | 'PHP'
+  | 'PKR'
+  | 'PLN'
+  | 'PYG'
+  | 'QAR'
+  | 'RON'
+  | 'RSD'
+  | 'RUB'
+  | 'RWF'
+  | 'SAR'
+  | 'SBD'
+  | 'SCR'
+  | 'SDG'
+  | 'SEK'
+  | 'SGD'
+  | 'SHP'
+  | 'SLL'
+  | 'SOS'
+  | 'SRD'
+  | 'SSP'
+  | 'STD'
+  | 'SVC'
+  | 'SYP'
+  | 'SZL'
+  | 'THB'
+  | 'TJS'
+  | 'TMT'
+  | 'TND'
+  | 'TOP'
+  | 'TRY'
+  | 'TTD'
+  | 'TWD'
+  | 'TZS'
+  | 'UAH'
+  | 'UGX'
+  | 'USN'
+  | 'USS'
+  | 'UYI'
+  | 'UYU'
+  | 'UZS'
+  | 'VEF'
+  | 'VND'
+  | 'VUV'
+  | 'WST'
+  | 'XAF'
+  | 'XAG'
+  | 'XAU'
+  | 'XBA'
+  | 'XBB'
+  | 'XBC'
+  | 'XBD'
+  | 'XCD'
+  | 'XDR'
+  | 'XOF'
+  | 'XPD'
+  | 'XPF'
+  | 'XPT'
+  | 'XTS'
+  | 'XXX'
+  | 'YER'
+  | 'ZAR'
+  | 'ZMK'
+  | 'ZMW'
+  | 'BTC'
+  | 'XUS'
+  | 'SLE'
+  | 'UNKNOWN';

package/src/setting/index.ts

@@ -0,0 +1,91 @@
+import { NativeMobilePaymentSetting } from './NativeMobilePaymentSetting';
+import type {
+  PaymentSettings,
+  SdkSettings,
+  Spec,
+  TrackingConsentState,
+} from './NativeMobilePaymentSetting';
+import { createMobilePaymentError } from '../util';
+
+class MobilePaymentSetting implements Omit<Spec, 'getConstants'> {
+  private readonly settingsManage: Spec;
+
+  constructor(settingsManage: Spec) {
+    this.settingsManage = settingsManage;
+  }
+
+  async initialize(applicationId: string): Promise<boolean> {
+    try {
+      return await this.settingsManage.initialize(applicationId);
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+  applicationId(): string | null {
+    try {
+      return this.settingsManage.applicationId();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  sdkSettings(): SdkSettings {
+    try {
+      return this.settingsManage.sdkSettings();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  paymentSettings(): PaymentSettings {
+    try {
+      return this.settingsManage.paymentSettings();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  trackingConsentState(): TrackingConsentState {
+    try {
+      return this.settingsManage.trackingConsentState();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async updateTrackingConsent(granted: boolean): Promise<void> {
+    try {
+      return await this.settingsManage.updateTrackingConsent(granted);
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async presentSettings(): Promise<void> {
+    try {
+      return await this.settingsManage.presentSettings();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async presentMockReaderUI(): Promise<void> {
+    try {
+      return await this.settingsManage.presentMockReaderUI();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+
+  async dismissMockReaderUI(): Promise<void> {
+    try {
+      return await this.settingsManage.dismissMockReaderUI();
+    } catch (e) {
+      throw createMobilePaymentError(e);
+    }
+  }
+}
+
+export const mobilePaymentSetting = new MobilePaymentSetting(
+  NativeMobilePaymentSetting
+);

package/src/type.ts

@@ -0,0 +1,35 @@
+export const PARAMS_ERROR = 'PARAMS_ERROR';
+export const UNKNOWN_ERROR = 'UNKNOWN_ERROR';
+
+export abstract class Exception {
+  /**
+   * @param message is JavaScript original message, in English usually.
+   * In prod environment, you are not advised to display the error message directly to end-user.
+   */
+  protected constructor(public message: string) {}
+}
+
+export interface SquareExceptionProps {
+  code?: string;
+  message: string;
+  debugCode?: string;
+  debugMessage?: string;
+}
+
+export class SquareException extends Exception {
+  code?: string;
+  debugCode?: string;
+  debugMessage?: string;
+
+  constructor({
+    message,
+    code,
+    debugCode,
+    debugMessage,
+  }: SquareExceptionProps) {
+    super(message);
+    this.code = code;
+    this.debugCode = debugCode;
+    this.debugMessage = debugMessage;
+  }
+}

package/src/util.ts

@@ -0,0 +1,31 @@
+import { SquareException } from './type';
+
+export function createMobilePaymentErrorFromCallback(ex: any) {
+  try {
+    const errorDetails = JSON.parse(ex);
+    return new SquareException({
+      code: errorDetails.code,
+      message: errorDetails.message,
+      debugCode: errorDetails?.debugCode,
+      debugMessage: errorDetails?.debugMessage,
+    });
+  } catch (parseEx) {
+    ex.parseEx = parseEx;
+    return ex;
+  }
+}
+
+export function createMobilePaymentError(ex: any) {
+  try {
+    const errorDetails = JSON.parse(ex.message);
+    return new SquareException({
+      code: errorDetails.code,
+      message: errorDetails.message,
+      debugCode: errorDetails?.debugCode,
+      debugMessage: errorDetails?.debugMessage,
+    });
+  } catch (parseEx) {
+    ex.parseEx = parseEx;
+    return ex;
+  }
+}