paynl-pos-sdk-react-native 0.0.57 → 0.0.60

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "paynl-pos-sdk-react-native",
-  "version": "0.0.57",
+  "version": "0.0.60",
   "description": "A PayNL sdk to accept and process payments",
-  "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",
   "exports": {
@@ -19,6 +18,7 @@
   },
   "access": "public",
   "files": [
+    "src",
     "lib",
     "android",
     "ios",

package/src/NativePayNlSdk.ts

@@ -0,0 +1,514 @@
+import { type TurboModule, TurboModuleRegistry } from 'react-native';
+import type {EventEmitter} from 'react-native/Libraries/Types/CodegenTypes';
+
+export interface Spec extends TurboModule {
+  /**
+   * Initialize the SDK. When booting the app, this is always the first step.
+   *
+   * @returns {NativeInitResult} - This value determines the next step.
+   *
+   * If *needs_login*, the app needs to call either *loginViaCode* or *loginViaCredentials*.
+   *
+   * If *ready_for_payments*, the app is ready to process the payment
+   */
+  initSdk(params: NativeInitModel): Promise<NativeInitResult>;
+
+  /**
+   * This allows you to update the configuration of the SDK
+   */
+  setConfiguration(params: NativeInitModel): void;
+
+  /**
+   * Fetches the activation code for login
+   */
+  getActivationCode(): Promise<ActivationResponseModel>;
+
+  /**
+   * Start login flow via the activation code
+   * @param code - The activated code. This value can be fetched via *getActivationCode()*
+   */
+  loginViaCode(code: string): Promise<void>;
+
+  /**
+   * Start login flow via credentials. a-code and sl & secret are request to start this process
+   * @param aCode
+   * @param serviceCode
+   * @param serviceSecret
+   */
+  loginViaCredentials(
+    aCode: string,
+    serviceCode: string,
+    serviceSecret: string
+  ): Promise<void>;
+
+  /**
+   * Starts a transaction via the Native SDK
+   */
+  startTransaction(params: { transaction: Transaction, forService?: Service }): Promise<TransactionResponseModel>;
+
+  cancelTransaction(): Promise<void>;
+
+  sendTicketViaEmail(email: string, transactionId: string, ticket: string): Promise<void>;
+
+  /**
+   * Prints a ticket with a supported printer
+   * @param ticket the base64 ticket
+   */
+  printTicket(ticket: string): Promise<void>;
+
+  /**
+   * Returns whether the PAY.SDK can find a supported printer on the device for ticket printing.
+   */
+  hasPrinter(): boolean;
+
+  getTerminalInfo(): TerminalInfo | undefined;
+
+  getAllowedCurrencies(): AllowedCurrency[] | undefined;
+
+  logout(): void;
+
+  sendLogs(): Promise<void>;
+
+  getOfflineQueue(): OfflineQueue;
+
+  triggerFullOfflineProcessing(): Promise<TransactionResponseModel[]>;
+
+  triggerSingleOfflineProcessing(id: string): Promise<TransactionResponseModel>;
+
+  clearOfflineItem(id: string): boolean;
+
+  onPaymentEvent: EventEmitter<OnPaymentEventParam>;
+}
+
+export interface NativeInitModel {
+  /**
+   * The integrationId needed to process payments.
+   * You can get one via PayNL support
+   */
+  integrationId: string;
+
+  /**
+   * The name of the license file in the application's assets folder
+   *
+   * _Android only_
+   */
+  licenseName?: string;
+
+  overlayParams?: PaymentOverlayParams;
+
+  pinPadLayoutParams?: PinPadLayoutParams;
+
+  /**
+   * This property allows the SDK to generate sounds based on the state of the reader.
+   * These are the same sounds generated by the PAY.POS application.
+   *
+   * If disabled, it is recommended to generate your own feedback (sounds/vibrations) for the user to track the reader state
+   *
+   * Default: true
+   *
+   * _Android only_
+   */
+  enableSound?: boolean;
+
+  /**
+   * Use the external display of the device (if available)
+   *
+   * Default: true
+   *
+   * _Android only_
+   */
+  useExternalDisplay?: boolean;
+
+  /**
+   * Allows the logger to persist logs.
+   * Logs older than 7days will be deleted.
+   *
+   * Allows the usages of the `PayNlSDK.sendLogs()` method
+   */
+  enableLogging?: boolean;
+
+  /**
+   * Enables scanning for Mifare cards. Make sure you handle Payment event MIFARE.
+   *
+   * Default: false
+   */
+  enableMifareScanning?: boolean;
+
+  /**
+   * Allows payments to be stored in cases of connection issues
+   */
+  enableOfflineProcessing?: boolean;
+
+  /**
+   * Enforces pin prompt during offline payment (if supported by card)
+   */
+  enforcePinCodeDuringOfflineProcessing?: boolean;
+
+  payNlCore: 'CPOC' | 'MULTI' | 'ZERO';
+}
+
+export type NativeInitResult = 'needs_login' | 'ready_for_payment';
+
+export interface ActivationResponseModel {
+  code: string;
+  expiresAt: string;
+}
+export interface PaymentOverlayParams {
+  /**
+   * Enables the overlay.
+   * <i>Default</i>: true
+   */
+  enabled?: boolean;
+
+  /**
+   * Controls the delay before automatically closing the overlay.
+   * If delay = 0, overlay will not be closed and dismiss & ticket buttons will be shown.
+   * <i>Default</i>: 0
+   */
+  closeDelayInMs?: number;
+
+  /**
+   * At the top of the overlay a logo is shown.
+   * Place your logo in the Android drawable and add the reference here.
+   * <i>Default</i>: res/drawable/paynl.png (PayNL logo)
+   */
+  logoImage?: string;
+
+  /**
+   * The reference to a custom waitingCard lottie animation.
+   * Make sure the Lottie JSON is placed in the res/raw folder.
+   * <i>Default</i>: res/raw/reader_animation.json (PayNL reader animation)
+   */
+  waitingCardAnimation?: string;
+
+  /**
+   * Customise the button styling.
+   * <i>Default</i>: res/drawable/pay_btn.xml (PayNl button shape)
+   */
+  buttonShape?: string;
+
+  /**
+   * The font family of the amount.
+   * <i>Default</i>: Lufga semibold
+   */
+  amountTextFontFamily?: string;
+
+  /**
+   * The font family of the payer message.
+   * <i>Default</i>: Inter regular
+   */
+  payerMessageTextFontFamily?: string;
+
+  /**
+   * The background color of the overlay.
+   * <i>Default</i>: #FFFFFFFF (white)
+   */
+  backgroundColor?: string;
+
+  /**
+   * The text color of the amount.
+   * <i>Default</i>: #FF444444
+   */
+  amountTextColor?: string;
+
+  /**
+   * The text color of the payerMessage.
+   * <i>Default</i>: #FF888888
+   */
+  payerMessageTextColor?: string;
+
+  /**
+   * The color of the loading spinner. Hex value only supported.
+   * <i>Default</i>: #FF585FFF
+   */
+  progressBarColor?: string;
+
+  /**
+   * The color of successfully payment. Hex value only supported.
+   * <i>Default</i>: #FF00D388
+   */
+  successColor?: string;
+
+  /**
+   * The color of error during payment. Hex value only supported.
+   * <i>Default</i>: #FFC5362C
+   */
+  errorColor?: string;
+
+  /**
+   * The text color of the buttons.
+   * <i>Default</i>: #FF000000
+   */
+  buttonTextColor?: string;
+
+  /**
+   * The text for the cancel button.
+   * <i>Default</i>: Annuleren
+   */
+  cancelButtonLabel?: string;
+
+  /**
+   * The text for the close button. Only visible if closeDelay = 0.
+   * <i>Default</i>: Sluiten
+   */
+  closeButtonLabel?: string;
+
+  /**
+   * The text for the "show ticket" button. Only visible if closeDelay = 0.
+   * <i>Default</i>: Open bon
+   */
+  ticketButtonLabel?: string;
+
+  /**
+   * The text while waiting for NFC detection.
+   * <i>Default</i>: Bied uw kaart aan
+   */
+  waitingCardLabel?: string;
+
+  /**
+   * The text while processing payment.
+   * <i>Default</i>: Betaling verwerken...
+   */
+  processingCardLabel?: string;
+
+  /**
+   * The text for in the header of the ticket viewer
+   * <i>Default</i>: Betaling succesvol!
+   */
+  ticketHeaderLabel?: string;
+
+  /**
+   * The text for in the header of the email prompt
+   * <i>Default</i>: Voer email adres in
+   */
+  emailHeaderLabel?: string;
+
+  /**
+   * The text for the email action
+   * <i>Default</i>: Mailen
+   */
+  emailButtonLabel?: string;
+}
+
+export interface PinPadLayoutParams {
+  /**
+   * The upper part of the screen shows a shadow during the WAIRTING_PINCODE.
+   * You can disable this and show your own content in the top part via this property
+   * <i>Default</i>: false
+   */
+  hideShadow?: boolean;
+
+  /**
+   * The hint text during WAITING_PINCODE.
+   * <i>Default</i>: Voer uw pincode in
+   */
+  waitingPincode?: string;
+
+  /**
+   * The background color of the overlay
+   * <i>Default</i>: #FFDDDDDD
+   */
+  backgroundColor?: string;
+
+  /**
+   * The text color of the numbers in the pin pad
+   * <i>Default</i>: #FF666666
+   */
+  numTextColor?: string;
+
+  /**
+   * The background color of the OK button in the pin pad
+   * <i>Default</i>: FF03A311
+   */
+  okButtonColor?: string;
+
+  /**
+   * The text color of the OK button in the pin pad
+   * <i>Default</i>: #FFFFFFFF
+   */
+  okButtonTextColor?: string;
+
+  /**
+   * The button color of the Clear button in the pin pad
+   * <i>Default</i>: #FFC5362C
+   */
+  clearButtonColor?: string;
+
+  /**
+   * The button color of the Delete button in the pin pad
+   * <i>Default</i>: #FFE37005
+   */
+  deleteButtonColor?: string;
+}
+
+
+type StatusAction = 'PAID' | 'FAILED' | 'DECLINED' | 'OFFLINE' | 'CANCELLED' | 'MIFARE';
+export interface TransactionResponseModel {
+  statusAction: StatusAction;
+  transactionId: string;
+  mifareSerial: string;
+  payerMessage: string;
+  orderId: string;
+  reference: string;
+  ticket: string;
+}
+
+export interface Transaction {
+  type?: 'PAYMENT' | 'REFUND';
+  serviceId?: string;
+  description?: string;
+  reference?: string;
+  exchangeUrl?: string;
+  amount: Amount;
+  paymentMethod?: PaymentMethod;
+  customer?: Customer;
+  order?: Order;
+  notification?: Notification;
+  stats?: Stats;
+  transferData?: TransferData[];
+  tguReference?: string;
+  ecrInitiated?: boolean;
+}
+
+export interface Amount {
+  value: number;
+  currency: string;
+}
+
+export interface PaymentMethod {
+  id?: string;
+  subId?: string;
+}
+
+export interface Company {
+  countryCode?: string;
+  coc?: string;
+  vat?: string;
+  name?: string;
+}
+
+export interface Customer {
+  firstName?: string;
+  lastName?: string;
+  phone?: string;
+  birthDate?: string;
+  gender?: string;
+  email?: string;
+  ipAddress?: string;
+  trust?: number;
+  reference?: string;
+  company?: Company;
+}
+
+export interface Address {
+  firstName?: string;
+  lastName?: string;
+  streetName?: string;
+  streetNumber?: string;
+  streetNumberExtension?: string;
+  zipCode?: string;
+  city?: string;
+  countryCode?: string;
+}
+
+export interface Product {
+  id?: string;
+  description?: string;
+  type?: string;
+  price?: ProductAmount;
+  quantity?: number;
+  vatCode?: string;
+}
+
+export interface ProductAmount {
+  value?: number;
+  currency?: string;
+}
+
+export interface DeliveryData {
+  firstName?: string;
+  lastName?: string;
+  streetName?: string;
+  streetNumber?: string;
+  streetNumberExtension?: string;
+  zipCode?: string;
+  city?: string;
+  countryCode?: string;
+}
+
+export interface Order {
+  countryCode?: string;
+  deliveryDate?: string;
+  invoiceDate?: string;
+  deliveryAddress?: DeliveryData;
+  invoiceAddress?: Address;
+  products?: Product[];
+}
+
+export interface Notification {
+  type?: string;
+  recipient?: string;
+}
+
+export interface Stats {
+  info?: string;
+  tool?: string;
+  extra1?: string;
+  extra2?: string;
+  extra3?: string;
+}
+
+export interface TransferData {
+  name: string;
+  value: string;
+}
+
+export interface Service {
+  serviceId: string;
+  secret: string;
+}
+
+export interface TerminalInfo {
+  terminal: { code: string; name: string; }
+  merchant: { code: string; name: string; }
+  service: { code: string; name: string; }
+  tradeName: { code: string; name: string; }
+  merchantLocation: { id: number; code: string; name: string; }
+}
+
+export interface AllowedCurrency {
+  id: string;
+  code: string;
+  sign: string;
+}
+
+export interface OfflineQueue {
+  size: number;
+  queue: OfflineQueueItem[];
+}
+
+export interface OfflineQueueItem {
+  id: string;
+  reference: string;
+  enqueuedAt: string;
+}
+
+export type OnPaymentEventType = 'PAYMENT_WAITING_CARD' | 'PAYMENT_PROCESSING' | 'PAYMENT_COMPLETED' | 'PAYMENT_FAILED' | 'PIN_WAITING' | 'PIN_CANCELLED' | 'MIFARE';
+
+export type OnPaymentEventParam = {
+  event: OnPaymentEventType;
+  data?: {
+    code?: string;
+    description?: string;
+    schemeBrand?: string;
+    usingSecondaryScreen?: 'true' | 'false';
+    statusAction?: StatusAction;
+    transactionId?: string;
+    orderId?: string;
+    reference?: string;
+    ticket?: string;
+    mifareSerial?: string;
+  };
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('PaynlSdk');

package/src/index.ts

@@ -0,0 +1,5 @@
+import PayNlSdk from './NativePayNlSdk';
+import type { Transaction, Service, Amount, Product, Order, Customer, ProductAmount, TransferData, Address, DeliveryData, Company, Stats, Notification, PaymentMethod, TerminalInfo, AllowedCurrency, OnPaymentEventParam, OfflineQueue, OfflineQueueItem } from './NativePayNlSdk'
+
+export { PayNlSdk };
+export type { Transaction, Service, Amount, Product, Order, Customer, ProductAmount, TransferData, Address, DeliveryData, Company, Stats, Notification, PaymentMethod, TerminalInfo, AllowedCurrency, OnPaymentEventParam, OfflineQueue, OfflineQueueItem };