react-native-payengine 2.0.17 → 2.0.18-alpha.1

package/src/components/v2/SecureFields/PEBankAccount.ts

@@ -1,12 +1,54 @@
+/**
+ * Represents a bank account stored within PayEngine.
+ *
+ * This interface contains a secure token and account details, ensuring sensitive banking
+ * information is securely managed within the system.
+ *
+ * @category SecureFields
+ */
 interface PEBankAccount {
+  /**
+   * A unique identifier for the bank account.
+   *
+   * This may be used internally to reference the bank account object.
+   */
   id: string;
+
+  /**
+   * A secure token representing the bank account.
+   *
+   * This token is used for referencing the account in API operations without exposing raw bank details.
+   */
   token: string;
+
+  /**
+   * The associated bank account details.
+   *
+   * Includes essential information such as the account holder's name,
+   * the routing number, and the last four digits of the account number.
+   */
   account_data: {
+    /**
+     * The first name of the account holder.
+     */
     first_name: string;
+
+    /**
+     * The last name of the account holder.
+     */
     last_name: string;
+
+    /**
+     * The bank's routing number.
+     */
     routing_number: string;
+
+    /**
+     * The last four digits of the bank account number.
+     */
     last_4: string;
   };
 }
 
+
 export default PEBankAccount;

package/src/components/v2/SecureFields/PECard.ts

@@ -1,14 +1,66 @@
+/**
+ * Represents a payment card stored with PayEngine.
+ *
+ * This interface contains a secure token and associated card details,
+ * ensuring sensitive payment information is securely managed within the system.
+ *
+ * @category SecureFields
+ */
 interface PECard {
+  /**
+   * A secure token representing the card.
+   *
+   * This token is used to safely reference the card in API operations without exposing raw card data.
+   */
   token: string;
+
+  /**
+   * The associated card details.
+   *
+   * Includes essential information such as brand, expiration date,
+   * the last four digits, cardholder name, and optional billing ZIP code.
+   */
   card_data: {
+    /**
+     * A unique identifier for the card.
+     *
+     * This ID is typically used to reference the card object in system operations.
+     */
     id: string;
+
+    /**
+     * The brand of the card (e.g., Visa, MasterCard).
+     */
     brand: string;
+
+    /**
+     * The last four digits of the card number.
+     *
+     * Useful for displaying or confirming the card to the user.
+     */
     last_4: string;
+
+    /**
+     * The expiration year of the card.
+     */
     exp_year: string;
+
+    /**
+     * The expiration month of the card.
+     */
     exp_month: string;
+
+    /**
+     * The name of the cardholder.
+     */
     name: string;
+
+    /**
+     * The ZIP code associated with the card's billing address (optional).
+     */
     address_zip?: string;
   };
 }
 
+
 export default PECard;

package/src/components/v2/SecureFields/PEKeyboardType.ts

@@ -1,4 +1,21 @@
-enum PEKeyboardType {
+import type IPEField from './IPEField';
+
+/**
+ * Defines the keyboard type for a PayEngine secure input field.
+ *
+ * @remarks
+ * This enum is used in {@link IPEField.keyboardType} to control the keyboard layout
+ * shown to the user based on the input field's context.
+ *
+ * The available keyboard types are:
+ * - {@link PEKeyboardType.alphabet} — Optimized for alphabetic characters.
+ * - {@link PEKeyboardType.number} — Optimized for numeric input.
+ * - {@link PEKeyboardType.phone} — Designed for entering phone numbers.
+ * - {@link PEKeyboardType.normal} — Standard keyboard with alphanumeric characters.
+ *
+ * @category SecureFields
+ */
+export enum PEKeyboardType {
   alphabet = 'alphabet',
   number = 'number',
   phone = 'phone',

package/src/index.tsx

@@ -1,23 +1,32 @@
+/**
+ * Main Module
+ * @module PayEngine SDK
+ */
+
 import PayEngine from './components/PayEngine';
 import { NativeModules, Platform } from 'react-native';
 import type { IPayEngineConfig } from './interfaces/index';
 import { PayProvider } from './interfaces/index';
+import type ITokenizationData from './components/v2/SecureFields/ITokenizationData'
 import {
   PECreditCardView,
-  PECreditCardViewMethods,
+  type PECreditCardViewProps,
+  type PECreditCardViewMethods,
 } from './components/v2/SecureFields/CreditCardView';
 import {
   PEBankAccountView,
-  PEBankAccountViewMethods,
+  type PEBankAccountViewProps,
+  type PEBankAccountViewMethods,
 } from './components/v2/SecureFields/BankAccountView';
 import type IPEField from './components/v2/SecureFields/IPEField';
 import type PECard from './components/v2/SecureFields/PECard';
 import type PEBankAccount from './components/v2/SecureFields/PEBankAccount';
 import { PayEngineProvider } from './components/v2/PayEngineProvider';
 import PayEngineNative from './components/v2/PayEngineNative';
-import { PEApplePayButton } from './components/v2/ApplePay/PEApplePayButton';
+import { FetchAccessTokenCallback, AccessToken } from './components/v2/PayEngineNative';
+import { PEApplePayButton, type PEApplePayButtonProps, type PEApplePayButtonMethods } from './components/v2/ApplePay/PEApplePayButton';
 
-import { PEGooglePayButton } from './components/v2/GooglePay/PEGooglePayButton';
+import { PEGooglePayButton, type PEGooglePayButtonProps, type PEGooglePayButtonMethods } from './components/v2/GooglePay/PEGooglePayButton';
 import * as PayEngineUtils from './utils/index';
 import PEKeyboardType from './components/v2/SecureFields/PEKeyboardType';
 import type { PEGooglePayAddress } from './components/v2/GooglePay/PEGooglePayAddress';
@@ -53,19 +62,26 @@ export {
   PayEngineUtils,
   PayEngineProvider,
   PayEngineNative,
+  AccessToken,
+  FetchAccessTokenCallback,
   // securefields
   PEKeyboardType,
   IPEField,
+  ITokenizationData,
   // credit card
   PECreditCardView,
+  PECreditCardViewProps,
   PECreditCardViewMethods,
   PECard,
   // bank account
   PEBankAccountView,
+  PEBankAccountViewProps,
   PEBankAccountViewMethods,
   PEBankAccount,
   // Apple Pay
   PEApplePayButton,
+  PEApplePayButtonProps,
+  PEApplePayButtonMethods,
   // RNPEApplePayOptions,
   // RNPEContactField,
   PEApplePayContact,
@@ -73,5 +89,7 @@ export {
   // RNPEGooglePayShippingAddressParameters,
   // PEPaymentRequest,
   PEGooglePayButton,
-  PEGooglePayAddress
+  PEGooglePayAddress,
+  PEGooglePayButtonProps,
+  PEGooglePayButtonMethods
 };

package/src/interfaces/index.ts

@@ -1,11 +1,49 @@
+/**
+ * Represents the configuration settings for PayEngine.
+ *
+ * The [IPayEngineConfig] interface holds essential details such as the public key,
+ * script version, and logging level. It is used to configure the PayEngine integration
+ * for API interactions.
+ *
+ */
 export interface IPayEngineConfig {
+  /**
+   * The public key associated with the PayEngine account.
+   * This key is required for authentication when making API requests.
+   */
   publicKey: string;
+
+  /**
+   * The version of the PayEngine integration.
+   * If provided, this specifies the version of the script or API being used.
+   */
   version?: string;
+
+  /**
+   * The script URL for loading the PayEngine JavaScript library.
+   * If provided, this URL is used instead of the default script URL.
+   */
   scriptURL?: string;
+
+  /**
+   * The log level for debugging.
+   * Higher values enable more detailed logging.
+   */
   logLevel?: number;
 }
 
+
+/**
+ * Enum representing supported payment providers.
+ *
+ * @remarks
+ * This enum specifies the available payment providers supported by the PayEngine SDK.
+ * It is used to check which payment method (Apple Pay or Google Pay) is available for use.
+ *
+ * @enum {string}
+ * @category PayEngine
+ */
 export enum PayProvider {
-  googlePay,
-  applePay
+  googlePay,  // Google Pay payment provider.
+  applePay    // Apple Pay payment provider.
 }

package/src/utils/index.ts

@@ -1,6 +1,12 @@
 import axios from 'axios';
 import type { IPayEngineConfig } from '../interfaces/index';
 
+/**
+ * Custom error thrown when an obsolete method is called.
+ *
+ * The `PEDeprecationError` indicates that the method being used is deprecated,
+ * and the user should check the package README for updated usage.
+ */
 export class PEDeprecationError extends Error {
   constructor() {
     super(
@@ -9,12 +15,18 @@ export class PEDeprecationError extends Error {
   }
 }
 
+/**
+ * @private
+ */
 export const getHttpHeaders = (config: IPayEngineConfig) => {
   return {
     Authorization: `Signature key="${config.publicKey}",algorithm="hmac-sha256",identifier="secure-fields",signature=""`,
   };
 };
 
+/**
+ * @private
+ */
 export const getBaseURL = (config: IPayEngineConfig) => {
   let baseUrl = config.publicKey.includes('_prod_')
     ? 'https://console.payengine.co'
@@ -26,6 +38,9 @@ export const getBaseURL = (config: IPayEngineConfig) => {
   return baseUrl;
 };
 
+/**
+ * @private
+ */
 export const createHttpClient = (config: IPayEngineConfig) => {
   return axios.create({
     baseURL: getBaseURL(config),
@@ -33,6 +48,9 @@ export const createHttpClient = (config: IPayEngineConfig) => {
   });
 };
 
+/**
+ * @private
+ */
 export function getScriptURL(config: IPayEngineConfig) {
   if (!config.publicKey) {
     throw new Error('PayEngine Public Key is missing');
@@ -52,6 +70,9 @@ export function getScriptURL(config: IPayEngineConfig) {
   return scriptURL;
 }
 
+/**
+ * @private
+ */
 export const debuggingScript = `
 const consoleLog = (type, ...log) => window.ReactNativeWebView.postMessage(JSON.stringify({'type': 'Console', 'data': {'type': type, 'log': log}}));
 console = {

package/ios/PayEngineSDK.xcframework/ios-arm64/PayEngineSDK.framework/Headers/CustomWindow.h

@@ -1,25 +0,0 @@
-//
-//  CustomWindow.h
-//  TouchDemo
-//
-//  Created by Astha Ameta on 19/08/20.
-//  Copyright © 2020 Kount Inc. All rights reserved.
-//
-
-#import <UIKit/UIKit.h>
-
-@protocol CustomWindowProtocol <NSObject>
--(void)touchesBeganCalledOfWindow:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchesEndedCalledOfWindow:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchesMovedCalledOfWindow:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
-@end
-
-NS_ASSUME_NONNULL_BEGIN
-
-@interface CustomWindow : UIWindow
-
-@property(weak, nonatomic) id<CustomWindowProtocol> touchDelegate;
-
-@end
-
-NS_ASSUME_NONNULL_END

package/ios/PayEngineSDK.xcframework/ios-arm64/PayEngineSDK.framework/Headers/UIControl+CustomControl.h

@@ -1,33 +0,0 @@
-//
-//  UIControl+CustomControl.h
-//  TouchDemo
-//
-//  Created by Astha Ameta on 19/08/20.
-//  Copyright © 2020 Kount Inc. All rights reserved.
-//
-
-#import <UIKit/UIKit.h>
-
-@interface UIButton (CustomButton)
-
-@end
-
-@interface UISlider (CustomSlider)
-
-@end
-
-@interface UIStepper (CustomStepper)
-
-@end
-
-@interface UIPageControl (CustomPageControl)
-
-@end
-
-@interface UIColorWell (CustomColorWell)
-
-@end
-
-@interface UIScrollView (CustomScrollView)
-
-@end

package/ios/PayEngineSDK.xcframework/ios-arm64/PayEngineSDK.framework/Headers/UIViewController+TouchControl.h

@@ -1,27 +0,0 @@
-//
-//  UIViewController+TouchControl.h
-//  TouchDemo
-//
-//  Created by Astha Ameta on 19/08/20.
-//  Copyright © 2020 Kount Inc. All rights reserved.
-//
-
-#import <UIKit/UIKit.h>
-#import "UIControl+CustomControl.h"
-
-@protocol CustomControlDelegate <NSObject>
--(void)touchBeganCalledWith:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchMovedCalledWith:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchEndedCalledWith:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
-// ... other methods here
-@end
-
-NS_ASSUME_NONNULL_BEGIN
-
-@interface UIViewController (TouchControl)
-
-@property (nonatomic, strong) id<CustomControlDelegate> touchDelegate;
-
-@end
-
-NS_ASSUME_NONNULL_END

package/ios/PayEngineSDK.xcframework/ios-arm64_x86_64-simulator/PayEngineSDK.framework/Headers/CustomWindow.h

@@ -1,25 +0,0 @@
-//
-//  CustomWindow.h
-//  TouchDemo
-//
-//  Created by Astha Ameta on 19/08/20.
-//  Copyright © 2020 Kount Inc. All rights reserved.
-//
-
-#import <UIKit/UIKit.h>
-
-@protocol CustomWindowProtocol <NSObject>
--(void)touchesBeganCalledOfWindow:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchesEndedCalledOfWindow:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchesMovedCalledOfWindow:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
-@end
-
-NS_ASSUME_NONNULL_BEGIN
-
-@interface CustomWindow : UIWindow
-
-@property(weak, nonatomic) id<CustomWindowProtocol> touchDelegate;
-
-@end
-
-NS_ASSUME_NONNULL_END

package/ios/PayEngineSDK.xcframework/ios-arm64_x86_64-simulator/PayEngineSDK.framework/Headers/UIControl+CustomControl.h

@@ -1,33 +0,0 @@
-//
-//  UIControl+CustomControl.h
-//  TouchDemo
-//
-//  Created by Astha Ameta on 19/08/20.
-//  Copyright © 2020 Kount Inc. All rights reserved.
-//
-
-#import <UIKit/UIKit.h>
-
-@interface UIButton (CustomButton)
-
-@end
-
-@interface UISlider (CustomSlider)
-
-@end
-
-@interface UIStepper (CustomStepper)
-
-@end
-
-@interface UIPageControl (CustomPageControl)
-
-@end
-
-@interface UIColorWell (CustomColorWell)
-
-@end
-
-@interface UIScrollView (CustomScrollView)
-
-@end

package/ios/PayEngineSDK.xcframework/ios-arm64_x86_64-simulator/PayEngineSDK.framework/Headers/UIViewController+TouchControl.h

@@ -1,27 +0,0 @@
-//
-//  UIViewController+TouchControl.h
-//  TouchDemo
-//
-//  Created by Astha Ameta on 19/08/20.
-//  Copyright © 2020 Kount Inc. All rights reserved.
-//
-
-#import <UIKit/UIKit.h>
-#import "UIControl+CustomControl.h"
-
-@protocol CustomControlDelegate <NSObject>
--(void)touchBeganCalledWith:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchMovedCalledWith:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
--(void)touchEndedCalledWith:(NSSet<UITouch *> *_Nullable)touches withEvent:(UIEvent *_Nullable)event;
-// ... other methods here
-@end
-
-NS_ASSUME_NONNULL_BEGIN
-
-@interface UIViewController (TouchControl)
-
-@property (nonatomic, strong) id<CustomControlDelegate> touchDelegate;
-
-@end
-
-NS_ASSUME_NONNULL_END