react-amwal-pay 0.1.8 → 0.1.10

package/README.md

@@ -1,128 +1,182 @@
-# react-amwal-pay
-
-A React Native library for integrating Amwal Pay payment gateway into your React Native applications.
-
-## Installation
-
-```sh
-npm install react-amwal-pay
-```
-
-### iOS Installation Note
-
-After pod installation, you need to set "Build Libraries for Distribution" to NO in Xcode:
-
-1. Open your iOS project in Xcode
-2. Go to Pods project
-3. Select amwalsdk target
-4. In Build Settings, search for "Build Libraries for Distribution"
-5. Set it to NO
-
-![Build Libraries Setting](https://github.com/amwal-pay/AnwalPaySDKReactNative/raw/master/docs/images/ios_install_note.png)
-
-#### Configuring amwalsdk Subspec
-
-The library uses amwalsdk as a dependency and supports both Release and Debug subspecs. By default, it uses the Debug subspec. To change this, you can set the `AMWAL_SUBSPEC` environment variable in your Podfile:
-
-```ruby
-# In your Podfile
-ENV['AMWAL_SUBSPEC'] = 'Release' # or 'Debug'
-```
-
-Or you can set it when running pod install:
-
-```bash
-AMWAL_SUBSPEC=Release pod install
-```
-
-## Usage
-
-```js
-import {
-  AmwalPaySDK,
-  Environment,
-  Currency,
-  TransactionType,
-  type AmwalPayConfig,
-  type AmwalPayResponse
-} from 'react-amwal-pay';
-
-// Configure Amwal Pay
-const config: AmwalPayConfig = {
-  environment: Environment.SIT, // or Environment.PRODUCTION
-  currency: Currency.OMR, // or other supported currencies
-  transactionType: TransactionType.CARD_WALLET,
-  locale: 'en', // or 'ar'
-  merchantId: '84131',
-  terminalId: '811018',
-  amount: '1',
-  secureHash: '8570CEED656C8818E4A7CE04F22206358F272DAD5F0227D322B654675ABF8F83',
-  customerId: 'customer-id', // optional
-  sessionToken: 'your-session-token', // optional
-  onCustomerId(customerId) {
-    console.log('Customer ID:', customerId);
-  },
-  onResponse(response) {
-    console.log('Payment Response:', response);
-  }
-};
-
-// Initialize and start payment
-const handlePayment = async () => {
-  try {
-    // Validate required fields
-    if (!isConfigValid(config)) {
-      console.error('Please fill in all required fields');
-      return;
-    }
-
-    const amwalPay = AmwalPaySDK.getInstance();
-    await amwalPay.startPayment(config);
-  } catch (error) {
-    console.error('Error starting payment:', error);
-  }
-};
-
-// Helper function to validate config
-const isConfigValid = (config: Partial<AmwalPayConfig>): boolean => {
-  return Boolean(
-    config.environment &&
-    config.secureHash &&
-    config.currency &&
-    config.amount &&
-    config.merchantId &&
-    config.terminalId &&
-    config.locale &&
-    config.transactionType
-  );
-};
-```
-
-## Configuration
-
-The `AmwalPayConfig` interface includes the following properties:
-
-- `environment`: The environment to use (SIT or PRODUCTION)
-- `currency`: The currency for the transaction (e.g., OMR)
-- `transactionType`: The type of transaction (e.g., CARD_WALLET)
-- `locale`: The language locale ('en' or 'ar')
-- `merchantId`: Your merchant ID
-- `terminalId`: Your terminal ID
-- `amount`: The transaction amount
-- `secureHash`: Your secure hash for authentication
-- `customerId`: (Optional) The customer's ID
-- `sessionToken`: (Optional) Your session token
-- `onCustomerId`: (Optional) Callback function for customer ID updates
-- `onResponse`: (Optional) Callback function for payment response
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
-
-## License
-
-MIT
-
----
-
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+# react-amwal-pay
+
+A React Native library for integrating Amwal Pay payment gateway into your React Native applications.
+
+## Installation
+
+```sh
+npm install react-amwal-pay
+```
+
+### iOS Installation Note
+
+After pod installation, you need to set "Build Libraries for Distribution" to NO in Xcode:
+
+1. Open your iOS project in Xcode
+2. Go to Pods project
+3. Select amwalsdk target
+4. In Build Settings, search for "Build Libraries for Distribution"
+5. Set it to NO
+
+![Build Libraries Setting](https://github.com/amwal-pay/AnwalPaySDKReactNative/raw/master/docs/images/ios_install_note.png)
+
+#### Configuring amwalsdk Subspec
+
+The library uses amwalsdk as a dependency and supports both Release and Debug subspecs. By default, it uses the Debug subspec. To change this, you can set the `AMWAL_SUBSPEC` environment variable in your Podfile:
+
+```ruby
+# In your Podfile
+ENV['AMWAL_SUBSPEC'] = 'Release' # or 'Debug'
+```
+
+Or you can set it when running pod install:
+
+```bash
+AMWAL_SUBSPEC=Release pod install
+```
+
+## Usage
+
+```js
+import {
+  AmwalPaySDK,
+  Environment,
+  Currency,
+  TransactionType,
+  UuidUtil,
+  type AmwalPayConfig,
+  type AmwalPayResponse
+} from 'react-amwal-pay';
+
+// Configure Amwal Pay
+const config: AmwalPayConfig = {
+  environment: Environment.SIT, // or Environment.PRODUCTION
+  currency: Currency.OMR, // or other supported currencies
+  transactionType: TransactionType.CARD_WALLET,
+  locale: 'en', // or 'ar'
+  merchantId: '84131',
+  terminalId: '811018',
+  amount: '1',
+  secureHash: '8570CEED656C8818E4A7CE04F22206358F272DAD5F0227D322B654675ABF8F83',
+  customerId: 'customer-id', // optional
+  sessionToken: 'your-session-token', // optional
+  transactionId: 'custom-transaction-id', // optional: auto-generated if not provided
+  additionValues: { // optional: custom key-value pairs for SDK configuration
+    merchantIdentifier: 'merchant.applepay.amwalpay', // for Apple Pay configuration
+    customKey: 'customValue' // add more as needed
+  },
+  onCustomerId(customerId) {
+    console.log('Customer ID:', customerId);
+  },
+  onResponse(response) {
+    console.log('Payment Response:', response);
+  }
+};
+
+// Initialize and start payment
+const handlePayment = async () => {
+  try {
+    // Validate required fields
+    if (!isConfigValid(config)) {
+      console.error('Please fill in all required fields');
+      return;
+    }
+
+    const amwalPay = AmwalPaySDK.getInstance();
+    await amwalPay.startPayment(config);
+  } catch (error) {
+    console.error('Error starting payment:', error);
+  }
+};
+
+// Helper function to validate config
+const isConfigValid = (config: Partial<AmwalPayConfig>): boolean => {
+  return Boolean(
+    config.environment &&
+    config.secureHash &&
+    config.currency &&
+    config.amount &&
+    config.merchantId &&
+    config.terminalId &&
+    config.locale &&
+    config.transactionType
+  );
+};
+```
+
+## UUID Generation
+
+If you need to generate a custom transaction ID, you can use the built-in UUID utility:
+
+```js
+import { UuidUtil } from 'react-amwal-pay';
+
+// Generate a UUID for transaction ID
+const transactionId = UuidUtil.generateTransactionId();
+
+// Or use the lower-level generator
+const uuid = UuidUtil.generateV4();
+```
+
+The UUID utility generates lowercase UUIDs in v4 format, ensuring compatibility with the payment system.
+
+## Addition Values Configuration
+
+The SDK supports `additionValues` parameter for passing custom key-value pairs that can be used for various SDK functionalities.
+
+### Default Addition Values
+
+The SDK automatically provides default values:
+- `merchantIdentifier`: "merchant.applepay.amwalpay" (used for Apple Pay configuration)
+
+### Usage
+
+```js
+// Using default additionValues (automatically applied)
+const config = {
+  // ... other configuration
+  // additionValues will automatically include merchantIdentifier
+};
+
+// Using custom additionValues
+const customConfig = {
+  // ... other configuration
+  additionValues: {
+    merchantIdentifier: 'merchant.custom.identifier',
+    customKey: 'customValue'
+  }
+};
+```
+
+Custom `additionValues` will be merged with defaults, with custom values taking precedence.
+
+## Configuration
+
+The `AmwalPayConfig` interface includes the following properties:
+
+- `environment`: The environment to use (SIT or PRODUCTION)
+- `currency`: The currency for the transaction (e.g., OMR)
+- `transactionType`: The type of transaction (e.g., CARD_WALLET)
+- `locale`: The language locale ('en' or 'ar')
+- `merchantId`: Your merchant ID
+- `terminalId`: Your terminal ID
+- `amount`: The transaction amount
+- `secureHash`: Your secure hash for authentication
+- `customerId`: (Optional) The customer's ID
+- `sessionToken`: (Optional) Your session token
+- `transactionId`: (Optional) Unique transaction identifier - auto-generated if not provided
+- `additionValues`: (Optional) Custom key-value pairs for SDK configuration (includes merchantIdentifier for Apple Pay)
+- `onCustomerId`: (Optional) Callback function for customer ID updates
+- `onResponse`: (Optional) Callback function for payment response
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT
+
+---
+
+Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

package/ReactAmwalPay.podspec

@@ -1,23 +1,23 @@
-require "json"
-
-package = JSON.parse(File.read(File.join(__dir__, "package.json")))
-
-Pod::Spec.new do |s|
-  s.name         = "ReactAmwalPay"
-  s.version      = package["version"]
-  s.summary      = package["description"]
-  s.homepage     = package["homepage"]
-  s.license      = package["license"]
-  s.authors      = package["author"]
-
-  s.platforms    = { :ios => min_ios_version_supported }
-  s.source       = { :git => "https://github.com/amwal-pay/AnwalPaySDKReactNative.git", :tag => "#{s.version}" }
-
-  s.source_files = "ios/**/*.{h,m,mm,swift}"
-  s.private_header_files = "ios/**/*.h"
-
-  # Default to Release subspec
-  amwal_subspec = ENV['AMWAL_SUBSPEC'] || 'Debug'
-  s.dependency "amwalsdk/#{amwal_subspec}"
-  install_modules_dependencies(s)
-end
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "ReactAmwalPay"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/amwal-pay/AnwalPaySDKReactNative.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+  s.private_header_files = "ios/**/*.h"
+
+  # Default to Release subspec
+  amwal_subspec = ENV['AMWAL_SUBSPEC'] || 'Release'
+  s.dependency "amwalsdk/#{amwal_subspec}"
+  install_modules_dependencies(s)
+end

package/android/build.gradle

@@ -1,93 +1,93 @@
-buildscript {
-  ext.getExtOrDefault = {name ->
-    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['ReactAmwalPay_' + name]
-  }
-
-  repositories {
-    google()
-    mavenCentral()
-  }
-
-  dependencies {
-    classpath "com.android.tools.build:gradle:8.7.3"
-    // noinspection DifferentKotlinGradleVersion
-    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
-  }
-}
-
-
-apply plugin: "com.android.library"
-apply plugin: "kotlin-android"
-
-apply plugin: "com.facebook.react"
-
-def getExtOrIntegerDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ReactAmwalPay_" + name]).toInteger()
-}
-
-android {
-  namespace "com.reactamwalpay"
-
-  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
-
-  defaultConfig {
-    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
-    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
-  }
-
-  buildFeatures {
-    buildConfig true
-  }
-
-  buildTypes {
-    release {
-      minifyEnabled false
-      shrinkResources false
-    }
-  }
-
-  lintOptions {
-    disable "GradleCompatible"
-  }
-
-  compileOptions {
-    sourceCompatibility JavaVersion.VERSION_1_8
-    targetCompatibility JavaVersion.VERSION_1_8
-  }
-
-  sourceSets {
-    main {
-      java.srcDirs += [
-        "generated/java",
-        "generated/jni"
-      ]
-    }
-  }
-}
-
-repositories {
-  mavenCentral()
-  google()
-}
-rootProject.allprojects { Project subproject ->
-    subproject.repositories {
-    maven { url = uri("https://storage.googleapis.com/download.flutter.io") }
-    }
-}
-def kotlin_version = getExtOrDefault("kotlinVersion")
-
-dependencies {
-  implementation "com.facebook.react:react-android"
-  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation("com.amwal-pay:amwal_sdk:+"){
-    exclude group: 'com.android.support', module: 'support-v4'
-    exclude group: 'com.android.support', module: 'design'
-  }
-
-}
-
-react {
-  jsRootDir = file("../src/")
-  libraryName = "ReactAmwalPay"
-  codegenJavaPackageName = "com.reactamwalpay"
-}
+buildscript {
+  ext.getExtOrDefault = {name ->
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['ReactAmwalPay_' + name]
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.7.3"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+  }
+}
+
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+apply plugin: "com.facebook.react"
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ReactAmwalPay_" + name]).toInteger()
+}
+
+android {
+  namespace "com.reactamwalpay"
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+      shrinkResources false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  sourceSets {
+    main {
+      java.srcDirs += [
+        "generated/java",
+        "generated/jni"
+      ]
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+rootProject.allprojects { Project subproject ->
+    subproject.repositories {
+    maven { url = uri("https://storage.googleapis.com/download.flutter.io") }
+    }
+}
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+  implementation("com.amwal-pay:amwal_sdk:+"){
+    exclude group: 'com.android.support', module: 'support-v4'
+    exclude group: 'com.android.support', module: 'design'
+  }
+
+}
+
+react {
+  jsRootDir = file("../src/")
+  libraryName = "ReactAmwalPay"
+  codegenJavaPackageName = "com.reactamwalpay"
+}

package/ios/ReactAmwalPay.m

@@ -1,14 +1,14 @@
-#import <React/RCTBridgeModule.h>
-#import <React/RCTEventEmitter.h>
-
-@interface RCT_EXTERN_MODULE(ReactAmwalPay, RCTEventEmitter)
-
-RCT_EXTERN_METHOD(initiate:(NSDictionary *)config
-                  resolver:(RCTPromiseResolveBlock)resolve
-                  rejecter:(RCTPromiseRejectBlock)reject)
-
-RCT_EXTERN_METHOD(onResponse:(RCTResponseSenderBlock)callback)
-
-RCT_EXTERN_METHOD(onCustomerId:(RCTResponseSenderBlock)callback)
-
-@end
+#import <React/RCTBridgeModule.h>
+#import <React/RCTEventEmitter.h>
+
+@interface RCT_EXTERN_MODULE(ReactAmwalPay, RCTEventEmitter)
+
+RCT_EXTERN_METHOD(initiate:(NSDictionary *)config
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+
+RCT_EXTERN_METHOD(onResponse:(RCTResponseSenderBlock)callback)
+
+RCT_EXTERN_METHOD(onCustomerId:(RCTResponseSenderBlock)callback)
+
+@end