@haroldtran/react-native-pax 0.1.8 → 1.0.1

package/.gitignore

@@ -38,3 +38,7 @@ yarn-error.*
 
 app-example
 .yarn/
+android/.idea/*
+android/.gradle/*
+android/gradle/wrapper/gradle-wrapper.jar
+android/local.properties

package/README.md

@@ -9,27 +9,23 @@ React Native library to integrate with PAX payment devices using the POSLink SDK
 
 ## Features
 
-- 🔄 Initialize PAX device connection
-- 💳 Process credit card payments (Sale, Auth, Post-Auth)
-- 🔄 Handle transaction adjustments and voids
+- 🔄 Initialize PAX device connection via TCP/IP
+- 💳 Process credit and debit card payments (Sale)
+- 🔄 Handle voids (Void Sale)
 - 📊 Batch operations and settlement
-- 🔙 Process returns and refunds
-- 📱 Support for both iOS and Android platforms
+- 🔙 Process refunds (Return)
+- 📱 Android platform support (iOS implementation pending)
 
 ## Installation
 
-```sh
-npm install @haroldtran/react-native-pax
-```
-
-or with yarn:
-
 ```sh
 yarn add @haroldtran/react-native-pax
 ```
 
 ### iOS Setup
 
+⚠️ **Note: iOS implementation is currently not complete. Only Android is fully supported at this time.**
+
 1. Navigate to your iOS project directory and install pods:
 ```sh
 cd ios && pod install
@@ -52,12 +48,9 @@ The Android setup is automatic. The library will be linked automatically when yo
 import {
   initPOSLink,
   makePayment,
-  makeAuth,
-  makePostAuth,
-  makeReturn,
-  makeAdjustment,
-  voidTransaction,
-  closeBatch
+  makeRefund,
+  makeVoid,
+  makeCloseBatch
 } from '@haroldtran/react-native-pax';
 ```
 
@@ -67,17 +60,8 @@ First, initialize the connection to your PAX device:
 
 ```js
 try {
-  const success = await initPOSLink(
-    'TCP',        // Connection type: 'UART', 'TCP', 'SSL', 'HTTP', 'HTTPS', 'BLUETOOTH', 'USB', 'AIDL'
-    '30000',      // Timeout in milliseconds
-    false,        // Use proxy
-    '192.168.1.100', // Device IP (for TCP/IP connections)
-    '10009'       // Port number
-  );
-
-  if (success) {
-    console.log('PAX device initialized successfully');
-  }
+  const result = await initPOSLink('192.168.1.100'); // Pass the IP address of the POS device
+  console.log('PAX device initialized:', result);
 } catch (error) {
   console.error('Failed to initialize PAX device:', error);
 }
@@ -86,56 +70,47 @@ try {
 ### Process a Payment
 
 ```js
-try {
-  const result = await makePayment('10.00', '1.50'); // amount, tip
-  console.log('Payment result:', result);
-
-  // Result contains transaction details like:
-  // - AuthCode
-  // - RefNum
-  // - ApprovedAmount
-  // - CardType
-  // - MaskedPAN
-  // etc.
-} catch (error) {
-  console.error('Payment failed:', error);
-}
-```
+import { CreditTransactionType } from '@haroldtran/react-native-pax/lib/typescript/module/type';
 
-### Authorization Only
-
-```js
 try {
-  const result = await makeAuth('25.00');
-  console.log('Authorization result:', result);
-} catch (error) {
-  console.error('Authorization failed:', error);
-}
-```
-
-### Post Authorization (Capture)
-
-```js
-try {
-  const result = await makePostAuth(
-    '25.00',           // amount
-    'REF123456',       // original reference number
-    'AUTH123'          // authorization code
+  const paymentResult = await makePayment(
+    'txn-123',                    // id (optional)
+    1000,                         // amount in cents (e.g., 1000 = $10.00)
+    150,                          // tip in cents (optional, e.g., 150 = $1.50)
+    CreditTransactionType.Credit, // paymentType (1 = Credit, 2 = Debit)
+    'ECR123'                      // ecrRefNum (optional)
   );
-  console.log('Post-auth result:', result);
+
+  console.log('Payment result:', paymentResult);
+  // paymentResult contains:
+  // - status: boolean
+  // - isPaymentSuccess: boolean
+  // - cardHolder: string
+  // - cardNumber: string (masked)
+  // - refNum: string
+  // - transactionId: string
+  // - amount: string
+  // - tipAmount: string
+  // - cardType: string
+  // - entryMethod: string
+  // - and more transaction details
 } catch (error) {
-  console.error('Post-auth failed:', error);
+  console.error('Payment failed:', error);
 }
 ```
 
-### Process a Return
+
+### Process a Refund
 
 ```js
 try {
-  const result = await makeReturn('15.00');
-  console.log('Return result:', result);
+  const refundResult = await makeRefund({
+    amount: 1500  // amount in cents (e.g., 1500 = $15.00)
+  });
+  console.log('Refund result:', refundResult);
+  // refundResult is a PaxResponseModel object
 } catch (error) {
-  console.error('Return failed:', error);
+  console.error('Refund failed:', error);
 }
 ```
 
@@ -143,42 +118,24 @@ try {
 
 ```js
 try {
-  const result = await voidTransaction(
-    'REF123456',       // original reference number
-    'AUTH123'          // authorization code
-  );
-  console.log('Void result:', result);
+  const voidResult = await makeVoid({
+    amount: 1500  // amount in cents (e.g., 1500 = $15.00)
+  });
+  console.log('Void result:', voidResult);
+  // voidResult is a PaxResponseModel object
 } catch (error) {
   console.error('Void failed:', error);
 }
 ```
 
-### Adjust a Transaction
-
-```js
-try {
-  const result = await makeAdjustment(
-    '12.50',           // new amount
-    'REF123456'        // original reference number
-  );
-  console.log('Adjustment result:', result);
-} catch (error) {
-  console.error('Adjustment failed:', error);
-}
-```
 
 ### Close Batch
 
 ```js
 try {
-  const result = await closeBatch();
-  console.log('Batch close result:', result);
-
-  // Result contains batch summary:
-  // - BatchNum
-  // - CreditCount, CreditAmount
-  // - DebitCount, DebitAmount
-  // etc.
+  const batchResult = await makeCloseBatch();
+  console.log('Batch close result:', batchResult);
+  // batchResult is a PaxResponseModel object
 } catch (error) {
   console.error('Batch close failed:', error);
 }
@@ -186,113 +143,114 @@ try {
 
 ## API Reference
 
-### initPOSLink(type, timeout, proxy, ip?, port?)
+#### initPOSLink(ip)
 
 Initializes the connection to the PAX device.
 
 **Parameters:**
-- `type` (string): Connection type - 'UART', 'TCP', 'SSL', 'HTTP', 'HTTPS', 'BLUETOOTH', 'USB', 'AIDL'
-- `timeout` (string): Timeout in milliseconds
-- `proxy` (boolean): Whether to use proxy
-- `ip` (string, optional): Device IP address (for network connections)
-- `port` (string, optional): Port number (for network connections)
+- `ip` (string): Device IP address
 
-**Returns:** `Promise<boolean>`
+**Returns:** `Promise<any>`
 
-### makePayment(amount, tip?)
+#### makePayment(id?, amount, tip?, paymentType?, ecrRefNum?)
 
-Processes a sale transaction.
+Initiates a payment transaction.
 
 **Parameters:**
-- `amount` (string): Transaction amount
-- `tip` (string, optional): Tip amount (default: "0")
+- `id` (string, optional): Transaction ID
+- `amount` (number): Payment amount in cents (e.g., 1000 = $10.00)
+- `tip` (number, optional): Tip amount in cents (e.g., 150 = $1.50)
+- `paymentType` (number, optional): Type of payment (1 = Credit, 2 = Debit, see `CreditTransactionType` enum)
+- `ecrRefNum` (string, optional): ECR reference number
 
-**Returns:** `Promise<PaymentResponse>`
+**Returns:** `Promise<PaxResponseModel>`
 
-### makeAuth(amount)
+#### makeRefund(data)
 
-Processes an authorization-only transaction.
+Initiates a refund transaction.
 
 **Parameters:**
-- `amount` (string): Authorization amount
+- `data` (object): Object containing:
+  - `amount` (number): The amount to refund in cents
 
-**Returns:** `Promise<PaymentResponse>`
+**Returns:** `Promise<PaxResponseModel>`
 
-### makePostAuth(amount, refNum, authCode)
+#### makeVoid(data)
 
-Captures a previously authorized transaction.
+Voids a transaction for the given amount.
 
 **Parameters:**
-- `amount` (string): Capture amount
-- `refNum` (string): Original reference number
-- `authCode` (string): Authorization code
-
-**Returns:** `Promise<PaymentResponse>`
+- `data` (object): Object containing:
+  - `amount` (number): The amount to void in cents
 
-### makeReturn(amount)
+**Returns:** `Promise<PaxResponseModel>`
 
-Processes a return transaction.
+#### makeCloseBatch()
 
-**Parameters:**
-- `amount` (string): Return amount
+Closes the current batch of transactions.
 
-**Returns:** `Promise<PaymentResponse>`
+**Returns:** `Promise<PaxResponseModel>`
 
-### makeAdjustment(amount, refNum)
-
-Adjusts a previous transaction amount.
-
-**Parameters:**
-- `amount` (string): New amount
-- `refNum` (string): Original reference number
-
-**Returns:** `Promise<PaymentResponse>`
+## Response Objects
 
-### voidTransaction(refNum, authCode)
 
-Voids a previous transaction.
+### PaxResponseModel
 
-**Parameters:**
-- `refNum` (string): Original reference number
-- `authCode` (string): Authorization code
+The response object returned by all transaction functions. Key fields include:
 
-**Returns:** `Promise<PaymentResponse>`
+**Status & Result:**
+- `status` (boolean): Overall operation success status
+- `isPaymentSuccess` (boolean): Payment-specific success flag
+- `message` (string): Response message or error description
 
-### closeBatch()
+**Transaction Details:**
+- `id` (string): Transaction ID
+- `transactionId` (string): Global unique transaction identifier
+- `transactionNo` (string): Transaction sequence number
+- `refNum` (string): Reference number
+- `transactionDateTime` (string): Date/time of transaction
 
-Closes the current batch and settles transactions.
+**Card & Payment Info:**
+- `cardType` (string): Card type/brand (e.g., VISA, MASTERCARD)
+- `cardNumber` (string): Masked card number
+- `cardHolder` (string): Card holder name
+- `entryMethod` (string): How card was entered (SWIPED_MSD, CONTACT_CHIP, CONTACTLESS_CHIP, etc.)
 
-**Returns:** `Promise<BatchResponse>`
-
-## Response Objects
+**Amount Details:**
+- `amount` (string): Transaction amount
+- `tipAmount` (string): Tip amount
+- `surcharge` (string): Additional fees/surcharge
 
-### PaymentResponse
+**Additional Data:**
+- `data` (object): Detailed response data including account info, trace info, AVS info, etc.
+- `sn` (string): Serial number
 
-Contains transaction details including:
-- `AuthCode`: Authorization code
-- `RefNum`: Reference number
-- `ApprovedAmount`: Approved amount
-- `CardType`: Type of card used
-- `MaskedPAN`: Masked card number
-- `ResultCode`: Transaction result code
-- `ResultTxt`: Result description
-- And many more fields...
+### CreditTransactionType Enum
 
-### BatchResponse
+Available payment types:
+- `CreditTransactionType.Credit` (1): Credit card transaction
+- `CreditTransactionType.Debit` (2): Debit card transaction
+- `CreditTransactionType.Empty` (0): Not set/default
 
-Contains batch settlement details including:
-- `BatchNum`: Batch number
-- `CreditCount` / `CreditAmount`: Credit transaction totals
-- `DebitCount` / `DebitAmount`: Debit transaction totals
-- `ResultCode`: Batch result code
-- And more batch summary fields...
+See `src/type.ts` for the complete interface definition.
 
 ## Requirements
 
 - React Native 0.63+
-- iOS 11.0+
-- Android API level 21+
+- **Android API level 21+ (Full support)**
+- **iOS 11.0+ (Limited support - implementation pending)**
 - PAX payment terminal with POSLink SDK support
+- TCP/IP network connection to PAX terminal
+
+## Current Platform Support
+
+| Feature               | Android | iOS |
+| --------------------- | ------- | --- |
+| Initialize Connection | ✅       | ❌   |
+| Payment Processing    | ✅       | ❌   |
+| Refunds               | ❌       | ❌   |
+| Voids                 | ❌       | ❌   |
+| Batch Operations      | ❌       | ❌   |
 
 ## Contributing
 

package/android/build.gradle

@@ -5,7 +5,8 @@ buildscript {
   }
 
   dependencies {
-    classpath "com.android.tools.build:gradle:7.2.1"
+    classpath("com.android.tools.build:gradle:8.3.2")
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.24")
   }
 }
 
@@ -14,6 +15,7 @@ def isNewArchitectureEnabled() {
 }
 
 apply plugin: "com.android.library"
+apply plugin: 'org.jetbrains.kotlin.android'
 
 
 def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
@@ -23,15 +25,19 @@ if (isNewArchitectureEnabled()) {
 }
 
 def getExtOrDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["PaxPoslink_" + name]
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["Default_" + name]
 }
 
 def getExtOrIntegerDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["PaxPoslink_" + name]).toInteger()
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["Default_" + name]).toInteger()
 }
 
 android {
   compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+  namespace 'com.paxposlink'
+  buildFeatures {
+    buildConfig true
+  }
 
   defaultConfig {
     minSdkVersion getExtOrIntegerDefault("minSdkVersion")
@@ -52,6 +58,9 @@ android {
     sourceCompatibility JavaVersion.VERSION_1_8
     targetCompatibility JavaVersion.VERSION_1_8
   }
+  kotlinOptions {
+    jvmTarget = '17'
+  }
 
 }
 
@@ -70,7 +79,9 @@ dependencies {
   //! https://developer.pax.us/resources/section/250038301709316096?sectionName=POSLink%202&articleId=352771637260593152
   //! POSLink_Core_Android_V2.00.07_20240914
   //! https://developer.pax.us/api/v1/files/314390436447793152/download/private#POSLink_Semi_Integration_Java_Android_V2.01.00_20240914.zip
-  implementation files('libs/POSLink_Core.jar')
+  implementation fileTree(dir: 'libs', include: ['*.jar'])
+  implementation 'androidx.core:core-ktx:1.16.0'
+  implementation 'com.google.code.gson:gson:2.11.0'
 }
 
 if (isNewArchitectureEnabled()) {

package/android/gradle.properties

@@ -1,5 +1,8 @@
-PaxPoslink_kotlinVersion=1.7.0
-PaxPoslink_minSdkVersion=21
-PaxPoslink_targetSdkVersion=31
-PaxPoslink_compileSdkVersion=31
-PaxPoslink_ndkversion=21.4.7075529
+Default_kotlinVersion=1.9.24
+Default_minSdkVersion=21
+Default_targetSdkVersion=31
+Default_compileSdkVersion=31
+Default_ndkversion=21.4.7075529
+Default_kotlin-gradle-plugin=1.9.24
+
+android.useAndroidX=true

package/android/src/main/java/com/paxposlink/PaxPosConstant.kt

@@ -0,0 +1,57 @@
+package com.paxposlink
+
+import com.facebook.react.bridge.WritableMap
+
+object PaxPosConstant {
+    const val DEFAULT_ID: String = ""
+    const val PORT: String = "10009"
+    const val TIMEOUT: Int = 300000
+}
+
+// Data holder for PAX request parameters
+data class PaxRequestModel(
+    var id: String? = "",
+    var amount: Int = 0,
+    var tip: Int? = null,
+    var paymentType: Int? = null,
+    var ecrRefNum: String = "",
+)
+
+data class PaxResponseModel(
+    var status: Boolean = false,
+    var data: WritableMap? = null,
+    var message: String = "",
+    var isPaymentSuccess: Boolean = false,
+    var id: String = "",
+    var transactionId: String = "",
+    var transactionNo: String = "",
+    var refNum: String = "",
+    var transactionDateTime: String = "",
+    var cardType: String = "",
+    var cardNumber: String = "",
+    var cardHolder: String = "",
+    var amount: String = "",
+    var tipAmount: String = "",
+    var surcharge: String = "",
+    var entryMethod: String = "",
+    var sn: String = "0",
+)
+
+data class PaxTerminalInfoModel(
+    var serialNumber: String = "",
+    var modelName: String = "",
+    var appName: String = "",
+)
+
+enum class CreditTransactionType(
+    val code: Int,
+) {
+    Credit(1),
+    Debit(2),
+    Empty(0),
+    ;
+
+    companion object {
+        fun fromCode(code: Int): CreditTransactionType = entries.find { it.code == code } ?: Empty
+    }
+}