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

package/lib/commonjs/components/v2/GooglePay/PEGooglePayButton.js.map

@@ -1 +1 @@
-{"version":3,"names":["RNPEEventEmitter","NativeModules","RNPEGooglePayButton","requireNativeComponent","peEventEmitter","NativeEventEmitter","PEGooglePayButton","React","forwardRef","props","ref","useImperativeHandle","useEffect","listener1","addListener","args","token","metadata","metadataString","billingAddress","billingAddressString","shippingAddress","shippingAddressString","console","log","JSON","parse","onTokenDidReturn","undefined","listener2","error","onPaymentFailed","Error","listener3","onPaymentSheetDismissed","remove","Platform","OS","height","width","style","stringify","paymentRequest","platformOptions"],"sources":["PEGooglePayButton.tsx"],"sourcesContent":["\nimport * as React from 'react';\nimport { NativeEventEmitter, NativeModules, Platform, requireNativeComponent, Text, ViewProps } from 'react-native';\nimport type { PEPaymentRequest } from '../PEPaymentRequest';\nimport type { PEGooglePayAddress } from './PEGooglePayAddress';\n\nconst { RNPEEventEmitter } = NativeModules;\n\nconst RNPEGooglePayButton = requireNativeComponent<NativePEGooglePayViewProps>('RNPEGooglePayButton');\n\ninterface NativePEGooglePayViewProps extends ViewProps {\n  // amount: number;\n  // merchantId: string;\n  paymentRequest: string;\n}\n\nconst peEventEmitter = new NativeEventEmitter(RNPEEventEmitter);\n\nexport interface PEGooglePayButtonProps extends ViewProps {\n  paymentRequest: PEPaymentRequest;\n  onTokenDidReturn?: (token: string, metadata?: any, billingAddress?: PEGooglePayAddress, shippingAddress?: PEGooglePayAddress) => void;\n  onPaymentSheetDismissed?: () => void;\n  onPaymentFailed?: (error: Error) => void;\n}\n\nexport interface PEGooglePayButtonMethods {\n  \n}\n\n\nexport const PEGooglePayButton = React.forwardRef<\n  PEGooglePayButtonMethods,\n  PEGooglePayButtonProps\n>((props, ref) => {\n\n  React.useImperativeHandle(ref, () => ({\n  }));\n\n  React.useEffect(() => {\n    const listener1 = peEventEmitter.addListener('onGooglePayRespond', args => {\n      const { token, metadata: metadataString, billingAddress: billingAddressString, shippingAddress: shippingAddressString } = args;\n      console.log('ON token', token, metadataString, billingAddressString, shippingAddressString)\n      const metadata = metadataString ? JSON.parse(metadataString) : null;\n      const billingAddress = billingAddressString ? JSON.parse(billingAddressString) as PEGooglePayAddress : null;\n      const shippingAddress = shippingAddressString ? JSON.parse(shippingAddressString) as PEGooglePayAddress : null;\n\n      props.onTokenDidReturn?.(token, metadata, billingAddress ?? undefined, shippingAddress ?? undefined)\n    });\n\n    const listener2 = peEventEmitter.addListener('onGooglePayError', args => {\n      const { error } = args;\n      console.log('ON error', error)\n      props.onPaymentFailed?.(new Error(error))\n    });\n\n    const listener3 = peEventEmitter.addListener('onGooglePayDismiss', () => {\n      console.log('ON dismiss')\n      props.onPaymentSheetDismissed?.()\n    });\n\n    return () => {\n      listener1.remove();\n      listener2.remove();\n      listener3.remove();\n    }\n  }, []);\n\n  if (Platform.OS !== 'android') {\n    return <Text>Google Pay is not supported on this platform</Text>\n  }\n  \n  return (\n    <RNPEGooglePayButton \n      style={{ height: 32, width: '100%', ...(props.style as object) }} \n      // amount={props.paymentRequest.paymentAmount}\n      // merchantId={props.paymentRequest.merchantId} \n      paymentRequest={JSON.stringify({\n        ...props.paymentRequest,\n        ...props.paymentRequest.platformOptions\n      })}\n    />\n  );\n});\n"],"mappings":";;;;;;;AACA;;AACA;;;;;;AAIA,MAAM;EAAEA;AAAF,IAAuBC,0BAA7B;AAEA,MAAMC,mBAAmB,GAAG,IAAAC,mCAAA,EAAmD,qBAAnD,CAA5B;AAQA,MAAMC,cAAc,GAAG,IAAIC,+BAAJ,CAAuBL,gBAAvB,CAAvB;AAcO,MAAMM,iBAAiB,gBAAGC,KAAK,CAACC,UAAN,CAG/B,CAACC,KAAD,EAAQC,GAAR,KAAgB;EAEhBH,KAAK,CAACI,mBAAN,CAA0BD,GAA1B,EAA+B,OAAO,EAAP,CAA/B;EAGAH,KAAK,CAACK,SAAN,CAAgB,MAAM;IACpB,MAAMC,SAAS,GAAGT,cAAc,CAACU,WAAf,CAA2B,oBAA3B,EAAiDC,IAAI,IAAI;MAAA;;MACzE,MAAM;QAAEC,KAAF;QAASC,QAAQ,EAAEC,cAAnB;QAAmCC,cAAc,EAAEC,oBAAnD;QAAyEC,eAAe,EAAEC;MAA1F,IAAoHP,IAA1H;MACAQ,OAAO,CAACC,GAAR,CAAY,UAAZ,EAAwBR,KAAxB,EAA+BE,cAA/B,EAA+CE,oBAA/C,EAAqEE,qBAArE;MACA,MAAML,QAAQ,GAAGC,cAAc,GAAGO,IAAI,CAACC,KAAL,CAAWR,cAAX,CAAH,GAAgC,IAA/D;MACA,MAAMC,cAAc,GAAGC,oBAAoB,GAAGK,IAAI,CAACC,KAAL,CAAWN,oBAAX,CAAH,GAA4D,IAAvG;MACA,MAAMC,eAAe,GAAGC,qBAAqB,GAAGG,IAAI,CAACC,KAAL,CAAWJ,qBAAX,CAAH,GAA6D,IAA1G;MAEA,yBAAAb,KAAK,CAACkB,gBAAN,qFAAAlB,KAAK,EAAoBO,KAApB,EAA2BC,QAA3B,EAAqCE,cAAc,IAAIS,SAAvD,EAAkEP,eAAe,IAAIO,SAArF,CAAL;IACD,CARiB,CAAlB;IAUA,MAAMC,SAAS,GAAGzB,cAAc,CAACU,WAAf,CAA2B,kBAA3B,EAA+CC,IAAI,IAAI;MAAA;;MACvE,MAAM;QAAEe;MAAF,IAAYf,IAAlB;MACAQ,OAAO,CAACC,GAAR,CAAY,UAAZ,EAAwBM,KAAxB;MACA,yBAAArB,KAAK,CAACsB,eAAN,qFAAAtB,KAAK,EAAmB,IAAIuB,KAAJ,CAAUF,KAAV,CAAnB,CAAL;IACD,CAJiB,CAAlB;IAMA,MAAMG,SAAS,GAAG7B,cAAc,CAACU,WAAf,CAA2B,oBAA3B,EAAiD,MAAM;MAAA;;MACvES,OAAO,CAACC,GAAR,CAAY,YAAZ;MACA,yBAAAf,KAAK,CAACyB,uBAAN,qFAAAzB,KAAK;IACN,CAHiB,CAAlB;IAKA,OAAO,MAAM;MACXI,SAAS,CAACsB,MAAV;MACAN,SAAS,CAACM,MAAV;MACAF,SAAS,CAACE,MAAV;IACD,CAJD;EAKD,CA3BD,EA2BG,EA3BH;;EA6BA,IAAIC,qBAAA,CAASC,EAAT,KAAgB,SAApB,EAA+B;IAC7B,oBAAO,oBAAC,iBAAD,uDAAP;EACD;;EAED,oBACE,oBAAC,mBAAD;IACE,KAAK,EAAE;MAAEC,MAAM,EAAE,EAAV;MAAcC,KAAK,EAAE,MAArB;MAA6B,GAAI9B,KAAK,CAAC+B;IAAvC,CADT,CAEE;IACA;IAHF;IAIE,cAAc,EAAEf,IAAI,CAACgB,SAAL,CAAe,EAC7B,GAAGhC,KAAK,CAACiC,cADoB;MAE7B,GAAGjC,KAAK,CAACiC,cAAN,CAAqBC;IAFK,CAAf;EAJlB,EADF;AAWD,CApDgC,CAA1B"}
+{"version":3,"names":["RNPEEventEmitter","NativeModules","RNPEGooglePayButton","requireNativeComponent","peEventEmitter","NativeEventEmitter","PEGooglePayButton","React","forwardRef","props","ref","useImperativeHandle","useEffect","listener1","addListener","args","token","metadata","metadataString","billingAddress","billingAddressString","shippingAddress","shippingAddressString","console","log","JSON","parse","onTokenDidReturn","undefined","listener2","error","onPaymentFailed","Error","listener3","onPaymentSheetDismissed","remove","Platform","OS","height","width","style","stringify","paymentRequest","platformOptions"],"sources":["PEGooglePayButton.tsx"],"sourcesContent":["\nimport * as React from 'react';\nimport { NativeEventEmitter, NativeModules, Platform, requireNativeComponent, Text, ViewProps } from 'react-native';\nimport type { PEPaymentRequest } from '../PEPaymentRequest';\nimport type { PEGooglePayAddress } from './PEGooglePayAddress';\n\nconst { RNPEEventEmitter } = NativeModules;\n\nconst RNPEGooglePayButton = requireNativeComponent<NativePEGooglePayViewProps>('RNPEGooglePayButton');\n\ninterface NativePEGooglePayViewProps extends ViewProps {\n  // amount: number;\n  // merchantId: string;\n  paymentRequest: string;\n}\n\nconst peEventEmitter = new NativeEventEmitter(RNPEEventEmitter);\n\n/**\n * Props for rendering the Google Pay payment button.\n *\n * This interface defines the configuration and callback handlers\n * used when initiating a Google Pay transaction.\n *\n * @category Google Pay\n */\nexport interface PEGooglePayButtonProps extends ViewProps {\n  /**\n   * The payment request containing merchant details, amount, currency,\n   * and optional payment item breakdown.\n   *\n   * This object defines the core transaction that will be processed.\n   */\n  paymentRequest: PEPaymentRequest;\n\n  /**\n   * Callback triggered when a Google Pay token is successfully returned.\n   *\n   * @param token - The Google Pay payment token as a string.\n   * @param metadata - Additional transaction metadata (if available).\n   * @param billingAddress - The billing address provided by Google Pay (optional).\n   * @param shippingAddress - The shipping address provided by Google Pay (optional).\n   *\n   * Example usage:\n   * ```ts\n   * onTokenDidReturn: (token, metadata, billingAddress, shippingAddress) => {\n   *   console.log(\"Token:\", token);\n   * }\n   * ```\n   */\n  onTokenDidReturn?: (\n    token: string,\n    metadata?: any,\n    billingAddress?: PEGooglePayAddress,\n    shippingAddress?: PEGooglePayAddress\n  ) => void;\n\n  /**\n   * Callback triggered when the Google Pay sheet is dismissed\n   * without completing the payment.\n   *\n   * Useful for UI updates or restoring state.\n   */\n  onPaymentSheetDismissed?: () => void;\n\n  /**\n   * Callback triggered when a payment fails during processing.\n   *\n   * @param error - An error object describing the cause of the failure.\n   *\n   * Example:\n   * ```ts\n   * onPaymentFailed: (error) => {\n   *   console.error(\"Payment failed:\", error.message);\n   * }\n   * ```\n   */\n  onPaymentFailed?: (error: Error) => void;\n}\n\n/**\n * Interface for defining methods related to the Google Pay button.\n *\n * Currently empty, this interface serves as a placeholder for any\n * platform-specific Google Pay button methods that may be added in the future.\n *\n * @category Google Pay\n */\nexport interface PEGooglePayButtonMethods { }\n\n/**\n * A React Native component for rendering a Google Pay button.\n *\n * This button allows users to initiate a Google Pay transaction using the\n * provided `paymentRequest`. The component communicates with native code\n * and emits events through a shared event emitter (`peEventEmitter`) to\n * notify the JavaScript layer about the payment result.\n *\n * ## Example Usage:\n * ```tsx\n * const paymentRequest = {\n *   merchantId: 'your-merchant-id',\n *   paymentAmount: 10.00,\n *   paymentItems: [\n *     { label: 'Test Item', amount: 10.00 }\n *   ],\n *   platformOptions: {\n *     billingAddressRequired: true,\n *     shippingAddressRequired: true,\n *   },\n * };\n * \n * <PEGooglePayButton\n *   paymentRequest={paymentRequest}\n *   onPaymentFailed={(error) => {\n *     console.log(\"Payment failed\", error);\n *   }}\n *   onPaymentSheetDismissed={() => {\n *     console.log(\"Payment sheet dismissed\");\n *   }}\n *   onTokenDidReturn={(token, metadata, billingAddress, shippingAddress) => {\n *     console.log(\"Payment successful\", token, metadata, billingAddress, shippingAddress);\n *   }}\n * />\n * ```\n *\n * ## Platform Support:\n * - **Android only**: On iOS, this component renders a fallback message.\n *\n * @param props - See {@link PEGooglePayButtonProps}\n * @returns A Google Pay button on Android or a fallback message on iOS.\n *\n * @category Google Pay\n */\nexport const PEGooglePayButton = React.forwardRef<\n  PEGooglePayButtonMethods,\n  PEGooglePayButtonProps\n>((props, ref) => {\n\n  React.useImperativeHandle(ref, () => ({\n  }));\n\n  React.useEffect(() => {\n    const listener1 = peEventEmitter.addListener('onGooglePayRespond', args => {\n      const { token, metadata: metadataString, billingAddress: billingAddressString, shippingAddress: shippingAddressString } = args;\n      console.log('ON token', token, metadataString, billingAddressString, shippingAddressString)\n      const metadata = metadataString ? JSON.parse(metadataString) : null;\n      const billingAddress = billingAddressString ? JSON.parse(billingAddressString) as PEGooglePayAddress : null;\n      const shippingAddress = shippingAddressString ? JSON.parse(shippingAddressString) as PEGooglePayAddress : null;\n\n      props.onTokenDidReturn?.(token, metadata, billingAddress ?? undefined, shippingAddress ?? undefined)\n    });\n\n    const listener2 = peEventEmitter.addListener('onGooglePayError', args => {\n      const { error } = args;\n      console.log('ON error', error)\n      props.onPaymentFailed?.(new Error(error))\n    });\n\n    const listener3 = peEventEmitter.addListener('onGooglePayDismiss', () => {\n      console.log('ON dismiss')\n      props.onPaymentSheetDismissed?.()\n    });\n\n    return () => {\n      listener1.remove();\n      listener2.remove();\n      listener3.remove();\n    }\n  }, []);\n\n  if (Platform.OS !== 'android') {\n    return <Text>Google Pay is not supported on this platform</Text>\n  }\n\n  return (\n    <RNPEGooglePayButton\n      style={{ height: 32, width: '100%', ...(props.style as object) }}\n      // amount={props.paymentRequest.paymentAmount}\n      // merchantId={props.paymentRequest.merchantId} \n      paymentRequest={JSON.stringify({\n        ...props.paymentRequest,\n        ...props.paymentRequest.platformOptions\n      })}\n    />\n  );\n});\n"],"mappings":";;;;;;;AACA;;AACA;;;;;;AAIA,MAAM;EAAEA;AAAF,IAAuBC,0BAA7B;AAEA,MAAMC,mBAAmB,GAAG,IAAAC,mCAAA,EAAmD,qBAAnD,CAA5B;AAQA,MAAMC,cAAc,GAAG,IAAIC,+BAAJ,CAAuBL,gBAAvB,CAAvB;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMM,iBAAiB,gBAAGC,KAAK,CAACC,UAAN,CAG/B,CAACC,KAAD,EAAQC,GAAR,KAAgB;EAEhBH,KAAK,CAACI,mBAAN,CAA0BD,GAA1B,EAA+B,OAAO,EAAP,CAA/B;EAGAH,KAAK,CAACK,SAAN,CAAgB,MAAM;IACpB,MAAMC,SAAS,GAAGT,cAAc,CAACU,WAAf,CAA2B,oBAA3B,EAAiDC,IAAI,IAAI;MAAA;;MACzE,MAAM;QAAEC,KAAF;QAASC,QAAQ,EAAEC,cAAnB;QAAmCC,cAAc,EAAEC,oBAAnD;QAAyEC,eAAe,EAAEC;MAA1F,IAAoHP,IAA1H;MACAQ,OAAO,CAACC,GAAR,CAAY,UAAZ,EAAwBR,KAAxB,EAA+BE,cAA/B,EAA+CE,oBAA/C,EAAqEE,qBAArE;MACA,MAAML,QAAQ,GAAGC,cAAc,GAAGO,IAAI,CAACC,KAAL,CAAWR,cAAX,CAAH,GAAgC,IAA/D;MACA,MAAMC,cAAc,GAAGC,oBAAoB,GAAGK,IAAI,CAACC,KAAL,CAAWN,oBAAX,CAAH,GAA4D,IAAvG;MACA,MAAMC,eAAe,GAAGC,qBAAqB,GAAGG,IAAI,CAACC,KAAL,CAAWJ,qBAAX,CAAH,GAA6D,IAA1G;MAEA,yBAAAb,KAAK,CAACkB,gBAAN,qFAAAlB,KAAK,EAAoBO,KAApB,EAA2BC,QAA3B,EAAqCE,cAAc,IAAIS,SAAvD,EAAkEP,eAAe,IAAIO,SAArF,CAAL;IACD,CARiB,CAAlB;IAUA,MAAMC,SAAS,GAAGzB,cAAc,CAACU,WAAf,CAA2B,kBAA3B,EAA+CC,IAAI,IAAI;MAAA;;MACvE,MAAM;QAAEe;MAAF,IAAYf,IAAlB;MACAQ,OAAO,CAACC,GAAR,CAAY,UAAZ,EAAwBM,KAAxB;MACA,yBAAArB,KAAK,CAACsB,eAAN,qFAAAtB,KAAK,EAAmB,IAAIuB,KAAJ,CAAUF,KAAV,CAAnB,CAAL;IACD,CAJiB,CAAlB;IAMA,MAAMG,SAAS,GAAG7B,cAAc,CAACU,WAAf,CAA2B,oBAA3B,EAAiD,MAAM;MAAA;;MACvES,OAAO,CAACC,GAAR,CAAY,YAAZ;MACA,yBAAAf,KAAK,CAACyB,uBAAN,qFAAAzB,KAAK;IACN,CAHiB,CAAlB;IAKA,OAAO,MAAM;MACXI,SAAS,CAACsB,MAAV;MACAN,SAAS,CAACM,MAAV;MACAF,SAAS,CAACE,MAAV;IACD,CAJD;EAKD,CA3BD,EA2BG,EA3BH;;EA6BA,IAAIC,qBAAA,CAASC,EAAT,KAAgB,SAApB,EAA+B;IAC7B,oBAAO,oBAAC,iBAAD,uDAAP;EACD;;EAED,oBACE,oBAAC,mBAAD;IACE,KAAK,EAAE;MAAEC,MAAM,EAAE,EAAV;MAAcC,KAAK,EAAE,MAArB;MAA6B,GAAI9B,KAAK,CAAC+B;IAAvC,CADT,CAEE;IACA;IAHF;IAIE,cAAc,EAAEf,IAAI,CAACgB,SAAL,CAAe,EAC7B,GAAGhC,KAAK,CAACiC,cADoB;MAE7B,GAAGjC,KAAK,CAACiC,cAAN,CAAqBC;IAFK,CAAf;EAJlB,EADF;AAWD,CApDgC,CAA1B"}

package/lib/commonjs/components/v2/PEPaymentRequest.js

@@ -7,7 +7,52 @@ exports.RNPEGooglePayShippingAddressParameters = exports.RNPEGooglePayOptions =
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+/**
+ * A union type that represents platform-specific payment options.
+ * 
+ * This can either be `RNPEGooglePayOptions` or `RNPEApplePayOptions`, depending
+ * on the platform.
+ * 
+ */
+
+/**
+ * A class representing a payment request containing all necessary transaction details.
+ *
+ * This includes merchant identifier, total payment amount, currency code,
+ * individual payment items, and optional platform-specific configurations
+ * such as Apple Pay or Google Pay options.
+ */
 class PEPaymentRequest {
+  /**
+   * The unique identifier for the merchant initiating the transaction.
+   */
+
+  /**
+   * The total amount to be charged for the transaction.
+   */
+
+  /**
+   * The currency code used for the transaction. Defaults to `'USD'`.
+   */
+
+  /**
+   * List of items representing the breakdown of the transaction.
+   */
+
+  /**
+   * Platform-specific options for customizing the payment experience
+   * (e.g., Apple Pay or Google Pay settings).
+   */
+
+  /**
+   * Constructs a new instance of [PEPaymentRequest].
+   *
+   * @param merchantId - The merchant's unique identifier.
+   * @param paymentAmount - The total transaction amount.
+   * @param currencyCode - The currency code (either `'USD'` or `'CAD'`).
+   * @param paymentItems - An array of individual summary items.
+   * @param platformOptions - Optional platform-specific payment configuration.
+   */
   constructor(merchantId, paymentAmount) {
     let currencyCode = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'USD';
     let paymentItems = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
@@ -31,9 +76,33 @@ class PEPaymentRequest {
   }
 
 }
+/**
+ * Represents an individual item in a payment transaction.
+ *
+ * Each item includes a label and an associated amount.
+ *
+ */
+
 
 exports.PEPaymentRequest = PEPaymentRequest;
+
+/**
+ * Contact fields that can be requested from the user during Apple Pay transactions.
+ *
+ * These fields specify what customer information (e.g., name, email, address) is required.
+ *
+ * @category Apple Pay
+ */
 let RNPEContactField;
+/**
+ * Options specific to Apple Pay payment flow.
+ *
+ * Includes configuration for required billing and shipping contact fields,
+ * as well as available shipping methods.
+ *
+ * @category Apple Pay
+ */
+
 exports.RNPEContactField = RNPEContactField;
 
 (function (RNPEContactField) {
@@ -45,6 +114,17 @@ exports.RNPEContactField = RNPEContactField;
 })(RNPEContactField || (exports.RNPEContactField = RNPEContactField = {}));
 
 class RNPEApplePayOptions {
+  /**
+   * Contact fields required for billing (e.g., name, address).
+   */
+
+  /**
+   * Contact fields required for shipping (e.g., phone number, address).
+   */
+
+  /**
+   * List of available shipping methods shown to the user.
+   */
   constructor(params) {
     _defineProperty(this, "requiredBillingContactFields", []);
 
@@ -58,6 +138,14 @@ class RNPEApplePayOptions {
   }
 
 }
+/**
+ * Represents the billing address parameters for Google Pay in React Native.
+ *
+ * Specifies the address format and whether a phone number is required.
+ *
+ * @category Google Pay
+ */
+
 
 exports.RNPEApplePayOptions = RNPEApplePayOptions;
 
@@ -69,6 +157,14 @@ class RNPEGooglePayBillingAddressParameters {
   }
 
 }
+/**
+ * Represents the shipping address parameters for Google Pay in React Native.
+ *
+ * Specifies the allowed countries and whether a phone number is required.
+ *
+ * @category Google Pay
+ */
+
 
 exports.RNPEGooglePayBillingAddressParameters = RNPEGooglePayBillingAddressParameters;
 
@@ -80,10 +176,35 @@ class RNPEGooglePayShippingAddressParameters {
   }
 
 }
+/**
+ * A class representing Google Pay-specific payment options for React Native.
+ * 
+ * This includes flags and parameters for requiring billing and shipping addresses.
+ * 
+ * @category Google Pay
+ */
+
 
 exports.RNPEGooglePayShippingAddressParameters = RNPEGooglePayShippingAddressParameters;
 
 class RNPEGooglePayOptions {
+  /** Whether a billing address is required for the transaction. */
+
+  /** Additional parameters for billing address collection (platform-specific). */
+
+  /** Whether a shipping address is required for the transaction. */
+
+  /** Additional parameters for shipping address collection (platform-specific). */
+
+  /**
+   * Creates a new instance of `RNPEGooglePayOptions`.
+   * 
+   * @param params - The configuration object for Google Pay options.
+   * @param params.billingAddressRequired - Whether billing address is required.
+   * @param params.shippingAddressRequired - Whether shipping address is required.
+   * @param params.billingAddressParameters - Optional parameters for billing address.
+   * @param params.shippingAddressParameters - Optional parameters for shipping address.
+   */
   constructor(params) {
     _defineProperty(this, "billingAddressRequired", void 0);
 

package/lib/commonjs/components/v2/PEPaymentRequest.js.map

@@ -1 +1 @@
-{"version":3,"names":["PEPaymentRequest","constructor","merchantId","paymentAmount","currencyCode","paymentItems","platformOptions","RNPEContactField","RNPEApplePayOptions","params","requiredBillingContactFields","requiredShippingContactFields","shippingMethods","RNPEGooglePayBillingAddressParameters","RNPEGooglePayShippingAddressParameters","undefined","RNPEGooglePayOptions","billingAddressRequired","billingAddressParameters","shippingAddressRequired","shippingAddressParameters"],"sources":["PEPaymentRequest.ts"],"sourcesContent":["import type { PEApplePayShippingMethod } from \"./ApplePay/PEApplePayInterfaces\";\n\ntype RNPEPaymentOptions = RNPEGooglePayOptions | RNPEApplePayOptions;\n\nexport class PEPaymentRequest {\n  merchantId: string;\n  paymentAmount: number;\n  currencyCode?: 'USD' | 'CAD' = 'USD';\n  paymentItems?: PESummaryItem[] = [];\n  platformOptions?: RNPEPaymentOptions;\n\n  constructor(\n    merchantId: string,\n    paymentAmount: number,\n    currencyCode: 'USD' | 'CAD' = 'USD',\n    paymentItems: {\n      amount: number;\n      label: string;\n    }[] = [],\n    platformOptions?: RNPEPaymentOptions\n  ) {\n    this.merchantId = merchantId;\n    this.paymentAmount = paymentAmount;\n    this.currencyCode = currencyCode;\n    this.paymentItems = paymentItems;\n    this.platformOptions = platformOptions;\n  }\n}\n\nexport interface PESummaryItem {\n  amount: number;\n  label: string;\n}\n\nexport enum RNPEContactField {\n  name = 'name',\n  postalAddress = 'postalAddress',\n  emailAddress = 'emailAddress',\n  phoneNumber = 'phoneNumber',\n  phoneticName = 'phoneticName',\n}\n\n\nexport class RNPEApplePayOptions {\n  requiredBillingContactFields?: RNPEContactField[] = [];\n  requiredShippingContactFields?: RNPEContactField[] = [];\n  shippingMethods?: PEApplePayShippingMethod[] = [];\n\n  constructor(params: {\n    requiredBillingContactFields: RNPEContactField[];\n    requiredShippingContactFields: RNPEContactField[];\n    shippingMethods: PEApplePayShippingMethod[];\n  }) {\n    this.requiredBillingContactFields = params.requiredBillingContactFields;\n    this.requiredShippingContactFields = params.requiredShippingContactFields;\n    this.shippingMethods = params.shippingMethods\n  }\n}\n\nexport class RNPEGooglePayBillingAddressParameters {\n  format: 'FULL' | 'MIN' = 'FULL'\n  phoneNumberRequired: boolean = false\n}\n\nexport class RNPEGooglePayShippingAddressParameters {\n  allowedCountryCodes?: string[] = undefined\n  phoneNumberRequired: boolean = false\n}\n\nexport class RNPEGooglePayOptions {\n  billingAddressRequired: boolean;\n  billingAddressParameters?: any;\n  shippingAddressRequired: boolean;\n  shippingAddressParameters?: any;\n\n  constructor(params: {\n    billingAddressRequired: boolean;\n    shippingAddressRequired: boolean;\n    billingAddressParameters?: RNPEGooglePayBillingAddressParameters;\n    shippingAddressParameters?: RNPEGooglePayShippingAddressParameters;\n  }) {\n    this.billingAddressRequired = params.billingAddressRequired;\n    this.billingAddressParameters = params.billingAddressParameters;\n    this.shippingAddressRequired = params.shippingAddressRequired;\n    this.shippingAddressParameters = params.shippingAddressParameters;\n  }\n}\n"],"mappings":";;;;;;;;;AAIO,MAAMA,gBAAN,CAAuB;EAO5BC,WAAW,CACTC,UADS,EAETC,aAFS,EAST;IAAA,IANAC,YAMA,uEAN8B,KAM9B;IAAA,IALAC,YAKA,uEAFM,EAEN;IAAA,IADAC,eACA;;IAAA;;IAAA;;IAAA,sCAb6B,KAa7B;;IAAA,sCAZ+B,EAY/B;;IAAA;;IACA,KAAKJ,UAAL,GAAkBA,UAAlB;IACA,KAAKC,aAAL,GAAqBA,aAArB;IACA,KAAKC,YAAL,GAAoBA,YAApB;IACA,KAAKC,YAAL,GAAoBA,YAApB;IACA,KAAKC,eAAL,GAAuBA,eAAvB;EACD;;AAtB2B;;;IA8BlBC,gB;;;WAAAA,gB;EAAAA,gB;EAAAA,gB;EAAAA,gB;EAAAA,gB;EAAAA,gB;GAAAA,gB,gCAAAA,gB;;AASL,MAAMC,mBAAN,CAA0B;EAK/BP,WAAW,CAACQ,MAAD,EAIR;IAAA,sDARiD,EAQjD;;IAAA,uDAPkD,EAOlD;;IAAA,yCAN4C,EAM5C;;IACD,KAAKC,4BAAL,GAAoCD,MAAM,CAACC,4BAA3C;IACA,KAAKC,6BAAL,GAAqCF,MAAM,CAACE,6BAA5C;IACA,KAAKC,eAAL,GAAuBH,MAAM,CAACG,eAA9B;EACD;;AAb8B;;;;AAgB1B,MAAMC,qCAAN,CAA4C;EAAA;IAAA,gCACxB,MADwB;;IAAA,6CAElB,KAFkB;EAAA;;AAAA;;;;AAK5C,MAAMC,sCAAN,CAA6C;EAAA;IAAA,6CACjBC,SADiB;;IAAA,6CAEnB,KAFmB;EAAA;;AAAA;;;;AAK7C,MAAMC,oBAAN,CAA2B;EAMhCf,WAAW,CAACQ,MAAD,EAKR;IAAA;;IAAA;;IAAA;;IAAA;;IACD,KAAKQ,sBAAL,GAA8BR,MAAM,CAACQ,sBAArC;IACA,KAAKC,wBAAL,GAAgCT,MAAM,CAACS,wBAAvC;IACA,KAAKC,uBAAL,GAA+BV,MAAM,CAACU,uBAAtC;IACA,KAAKC,yBAAL,GAAiCX,MAAM,CAACW,yBAAxC;EACD;;AAhB+B"}
+{"version":3,"names":["PEPaymentRequest","constructor","merchantId","paymentAmount","currencyCode","paymentItems","platformOptions","RNPEContactField","RNPEApplePayOptions","params","requiredBillingContactFields","requiredShippingContactFields","shippingMethods","RNPEGooglePayBillingAddressParameters","RNPEGooglePayShippingAddressParameters","undefined","RNPEGooglePayOptions","billingAddressRequired","billingAddressParameters","shippingAddressRequired","shippingAddressParameters"],"sources":["PEPaymentRequest.ts"],"sourcesContent":["import type { PEApplePayShippingMethod } from \"./ApplePay/PEApplePayInterfaces\";\n\n/**\n * A union type that represents platform-specific payment options.\n * \n * This can either be `RNPEGooglePayOptions` or `RNPEApplePayOptions`, depending\n * on the platform.\n * \n */\nexport type RNPEPaymentOptions = RNPEGooglePayOptions | RNPEApplePayOptions;\n\n/**\n * A class representing a payment request containing all necessary transaction details.\n *\n * This includes merchant identifier, total payment amount, currency code,\n * individual payment items, and optional platform-specific configurations\n * such as Apple Pay or Google Pay options.\n */\nexport class PEPaymentRequest {\n  /**\n   * The unique identifier for the merchant initiating the transaction.\n   */\n  merchantId: string;\n\n  /**\n   * The total amount to be charged for the transaction.\n   */\n  paymentAmount: number;\n\n  /**\n   * The currency code used for the transaction. Defaults to `'USD'`.\n   */\n  currencyCode?: 'USD' | 'CAD' = 'USD';\n\n  /**\n   * List of items representing the breakdown of the transaction.\n   */\n  paymentItems?: PESummaryItem[] = [];\n\n  /**\n   * Platform-specific options for customizing the payment experience\n   * (e.g., Apple Pay or Google Pay settings).\n   */\n  platformOptions?: RNPEPaymentOptions;\n\n  /**\n   * Constructs a new instance of [PEPaymentRequest].\n   *\n   * @param merchantId - The merchant's unique identifier.\n   * @param paymentAmount - The total transaction amount.\n   * @param currencyCode - The currency code (either `'USD'` or `'CAD'`).\n   * @param paymentItems - An array of individual summary items.\n   * @param platformOptions - Optional platform-specific payment configuration.\n   */\n  constructor(\n    merchantId: string,\n    paymentAmount: number,\n    currencyCode: 'USD' | 'CAD' = 'USD',\n    paymentItems: PESummaryItem[] = [],\n    platformOptions?: RNPEPaymentOptions\n  ) {\n    this.merchantId = merchantId;\n    this.paymentAmount = paymentAmount;\n    this.currencyCode = currencyCode;\n    this.paymentItems = paymentItems;\n    this.platformOptions = platformOptions;\n  }\n}\n\n/**\n * Represents an individual item in a payment transaction.\n *\n * Each item includes a label and an associated amount.\n *\n */\nexport interface PESummaryItem {\n  /** A descriptive label for the payment item (e.g., \"Item 1\"). */\n  label: string;\n\n  /** The monetary amount for this item. */\n  amount: number;\n}\n\n/**\n * Contact fields that can be requested from the user during Apple Pay transactions.\n *\n * These fields specify what customer information (e.g., name, email, address) is required.\n *\n * @category Apple Pay\n */\nexport enum RNPEContactField {\n  /** The customer's full name. */\n  name = 'name',\n\n  /** The customer's postal address. */\n  postalAddress = 'postalAddress',\n\n  /** The customer's email address. */\n  emailAddress = 'emailAddress',\n\n  /** The customer's phone number. */\n  phoneNumber = 'phoneNumber',\n\n  /** The phonetic spelling of the customer's name. */\n  phoneticName = 'phoneticName',\n}\n\n\n/**\n * Options specific to Apple Pay payment flow.\n *\n * Includes configuration for required billing and shipping contact fields,\n * as well as available shipping methods.\n *\n * @category Apple Pay\n */\nexport class RNPEApplePayOptions {\n  /**\n   * Contact fields required for billing (e.g., name, address).\n   */\n  requiredBillingContactFields?: RNPEContactField[] = [];\n\n  /**\n   * Contact fields required for shipping (e.g., phone number, address).\n   */\n  requiredShippingContactFields?: RNPEContactField[] = [];\n\n  /**\n   * List of available shipping methods shown to the user.\n   */\n  shippingMethods?: PEApplePayShippingMethod[] = [];\n\n  constructor(params: {\n    requiredBillingContactFields: RNPEContactField[];\n    requiredShippingContactFields: RNPEContactField[];\n    shippingMethods: PEApplePayShippingMethod[];\n  }) {\n    this.requiredBillingContactFields = params.requiredBillingContactFields;\n    this.requiredShippingContactFields = params.requiredShippingContactFields;\n    this.shippingMethods = params.shippingMethods;\n  }\n}\n\n/**\n * Represents the billing address parameters for Google Pay in React Native.\n *\n * Specifies the address format and whether a phone number is required.\n *\n * @category Google Pay\n */\nexport class RNPEGooglePayBillingAddressParameters {\n  /**\n   * The format of the billing address.\n   * \n   * - `'FULL'`: Includes street, city, state, and postal code.\n   * - `'MIN'`: Minimal format with limited address details.\n   */\n  format: 'FULL' | 'MIN' = 'FULL';\n\n  /**\n   * Whether a phone number is required in the billing address.\n   */\n  phoneNumberRequired: boolean = false;\n}\n\n/**\n * Represents the shipping address parameters for Google Pay in React Native.\n *\n * Specifies the allowed countries and whether a phone number is required.\n *\n * @category Google Pay\n */\nexport class RNPEGooglePayShippingAddressParameters {\n  /**\n   * A list of allowed country codes for shipping (e.g., `[\"US\", \"CA\"]`).\n   */\n  allowedCountryCodes?: string[] = undefined;\n\n  /**\n   * Whether a phone number is required in the shipping address.\n   */\n  phoneNumberRequired: boolean = false;\n}\n\n/**\n * A class representing Google Pay-specific payment options for React Native.\n * \n * This includes flags and parameters for requiring billing and shipping addresses.\n * \n * @category Google Pay\n */\nexport class RNPEGooglePayOptions {\n  /** Whether a billing address is required for the transaction. */\n  billingAddressRequired: boolean;\n\n  /** Additional parameters for billing address collection (platform-specific). */\n  billingAddressParameters?: RNPEGooglePayBillingAddressParameters;\n\n  /** Whether a shipping address is required for the transaction. */\n  shippingAddressRequired: boolean;\n\n  /** Additional parameters for shipping address collection (platform-specific). */\n  shippingAddressParameters?: RNPEGooglePayShippingAddressParameters;\n\n  /**\n   * Creates a new instance of `RNPEGooglePayOptions`.\n   * \n   * @param params - The configuration object for Google Pay options.\n   * @param params.billingAddressRequired - Whether billing address is required.\n   * @param params.shippingAddressRequired - Whether shipping address is required.\n   * @param params.billingAddressParameters - Optional parameters for billing address.\n   * @param params.shippingAddressParameters - Optional parameters for shipping address.\n   */\n  constructor(params: {\n    billingAddressRequired: boolean;\n    shippingAddressRequired: boolean;\n    billingAddressParameters?: RNPEGooglePayBillingAddressParameters;\n    shippingAddressParameters?: RNPEGooglePayShippingAddressParameters;\n  }) {\n    this.billingAddressRequired = params.billingAddressRequired;\n    this.billingAddressParameters = params.billingAddressParameters;\n    this.shippingAddressRequired = params.shippingAddressRequired;\n    this.shippingAddressParameters = params.shippingAddressParameters;\n  }\n}\n"],"mappings":";;;;;;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,gBAAN,CAAuB;EAC5B;AACF;AACA;;EAGE;AACF;AACA;;EAGE;AACF;AACA;;EAGE;AACF;AACA;;EAGE;AACF;AACA;AACA;;EAGE;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAW,CACTC,UADS,EAETC,aAFS,EAMT;IAAA,IAHAC,YAGA,uEAH8B,KAG9B;IAAA,IAFAC,YAEA,uEAFgC,EAEhC;IAAA,IADAC,eACA;;IAAA;;IAAA;;IAAA,sCA5B6B,KA4B7B;;IAAA,sCAvB+B,EAuB/B;;IAAA;;IACA,KAAKJ,UAAL,GAAkBA,UAAlB;IACA,KAAKC,aAAL,GAAqBA,aAArB;IACA,KAAKC,YAAL,GAAoBA,YAApB;IACA,KAAKC,YAAL,GAAoBA,YAApB;IACA,KAAKC,eAAL,GAAuBA,eAAvB;EACD;;AAhD2B;AAmD9B;AACA;AACA;AACA;AACA;AACA;;;;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;IACYC,gB;AAkBZ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WAzBYA,gB;EAAAA,gB;EAAAA,gB;EAAAA,gB;EAAAA,gB;EAAAA,gB;GAAAA,gB,gCAAAA,gB;;AA0BL,MAAMC,mBAAN,CAA0B;EAC/B;AACF;AACA;;EAGE;AACF;AACA;;EAGE;AACF;AACA;EAGEP,WAAW,CAACQ,MAAD,EAIR;IAAA,sDAhBiD,EAgBjD;;IAAA,uDAXkD,EAWlD;;IAAA,yCAN4C,EAM5C;;IACD,KAAKC,4BAAL,GAAoCD,MAAM,CAACC,4BAA3C;IACA,KAAKC,6BAAL,GAAqCF,MAAM,CAACE,6BAA5C;IACA,KAAKC,eAAL,GAAuBH,MAAM,CAACG,eAA9B;EACD;;AAxB8B;AA2BjC;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACO,MAAMC,qCAAN,CAA4C;EAAA;IAAA,gCAOxB,MAPwB;;IAAA,6CAYlB,KAZkB;EAAA;;AAAA;AAenD;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACO,MAAMC,sCAAN,CAA6C;EAAA;IAAA,6CAIjBC,SAJiB;;IAAA,6CASnB,KATmB;EAAA;;AAAA;AAYpD;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACO,MAAMC,oBAAN,CAA2B;EAChC;;EAGA;;EAGA;;EAGA;;EAGA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEf,WAAW,CAACQ,MAAD,EAKR;IAAA;;IAAA;;IAAA;;IAAA;;IACD,KAAKQ,sBAAL,GAA8BR,MAAM,CAACQ,sBAArC;IACA,KAAKC,wBAAL,GAAgCT,MAAM,CAACS,wBAAvC;IACA,KAAKC,uBAAL,GAA+BV,MAAM,CAACU,uBAAtC;IACA,KAAKC,yBAAL,GAAiCX,MAAM,CAACW,yBAAxC;EACD;;AAhC+B"}

package/lib/commonjs/components/v2/PayEngineNative.js

@@ -9,22 +9,79 @@ var _reactNative = require("react-native");
 
 var _interfaces = require("../../interfaces");
 
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 const {
-  RNPayEngineNative
+  RNPayEngineNative,
+  RNPEEventEmitter
 } = _reactNative.NativeModules;
+/**
+ * Represents an access token used for authenticating with the PayEngine SDK.
+ *
+ * @remarks
+ * The access token contains the actual token string and the duration (in seconds)
+ * for which the token remains valid. This is typically retrieved from your backend
+ * and used for making authenticated requests.
+ *
+ * @property accessToken - The access token string.
+ * @property expiresIn - The time (in seconds) until the token expires.
+ *  
+ * @category PayEngine
+ */
 
+/**
+ * Provides an interface for interacting with the native PayEngine SDK.
+ *
+ * @remarks
+ * `PayEngineNative` acts as a bridge between your React Native JavaScript code and
+ * the native PayEngine SDKs on iOS and Android. It utilizes React Native's
+ * Native Modules and platform channels to enable core payment functionalities.
+ *
+ * These include:
+ * - Fraud monitoring
+ * - Browser/device info retrieval
+ * - Support detection for Apple Pay and Google Pay
+ *
+ *
+ * @category PayEngine
+ */
 class PayEngineNative {
+  constructor() {}
+  /**
+   * Retrieves a fraud monitoring session ID from the native PayEngine SDK.
+   *
+   *
+   * @param merchantId - The unique identifier for the merchant.
+   * @returns A `Promise<string>` containing the fraud monitoring session ID.
+   */
+
+
   static async createFraudMonitorSession(merchantId) {
     return RNPayEngineNative.createFraudMonitorSession(merchantId);
   }
+  /**
+   * Retrieves browser-related information from the native PayEngine SDK.
+   *
+   * @returns A `Promise<string>` containing browser and device details.
+   *
+   */
+
 
   static async getBrowserInfo() {
     return RNPayEngineNative.getBrowserInfo();
   }
   /**
-   * @deprecated use userCanPay instead
-   * @param merchantId 
-   * @returns 
+   * @deprecated Use {@link PayEngineNative.userCanPay} instead.
+   *
+   * Checks if platform-native payments (Apple Pay or Google Pay) are supported on the current device.
+   *
+   * @remarks
+   * This method has been deprecated in favor of {@link PayEngineNative.userCanPay}, which allows specifying
+   * the payment provider explicitly.
+   *
+   * @param merchantId - The unique identifier for the merchant.
+   * @returns A `Promise<boolean>` indicating whether the platform-specific payment method is supported.
+   *
    */
 
 
@@ -37,6 +94,22 @@ class PayEngineNative {
 
     return false;
   }
+  /**
+   * Checks if the user can make payments using Apple Pay (iOS) or Google Pay (Android).
+   *
+   * @remarks
+   * This method verifies whether the current device and platform support the selected payment provider.
+   * It performs a platform-specific check using the native PayEngine SDK for either Apple Pay or Google Pay.
+   *
+   * ## Supported Providers
+   * - `PayProvider.googlePay` (Android only)
+   * - `PayProvider.applePay` (iOS only)
+   *
+   * @param provider - The payment provider to check support for.
+   * @param merchantId - The unique identifier for the merchant.
+   * @returns A `Promise<boolean>` indicating whether the selected payment method is supported.
+   */
+
 
   static async userCanPay(provider, merchantId) {
     if (provider == _interfaces.PayProvider.applePay && _reactNative.Platform.OS == 'ios') {
@@ -47,8 +120,113 @@ class PayEngineNative {
 
     return false;
   }
+  /**
+   * Sets the callback function that provides an access token when required by PayEngine.
+   *
+   * @remarks
+   * When the PayEngine SDK needs an access token, it will call this callback function
+   * to request the host application to fetch a new token from its backend.
+   * 
+   * The SDK uses this token internally to make calls to merchant related APIs which require merchant's credentials.
+   *
+   * ## Important:
+   * - PayEngine will invoke this callback **whenever an access token is needed or needs to be refreshed**.
+   * - The integrator must ensure that the token retrieval logic is secure and efficient in their backend.
+   * - For more details on how to retrieve the access token from Payengine, refer to the official documentation:
+   *   [PayEngine Merchant Session](https://docs.payengine.co/merchant-session#obtaining-a-new-merchant-session)
+   *
+   * ## Example Usage
+   * ```ts
+   * const fetchAccessToken = async (): Promise<AccessToken> => {
+   *   try {
+   *     // Make a network request to your server to fetch the token
+   *     // Your server then makes a request to Payengine securely and returns the results back in response
+   *     const response = await fetch("https://yourserver.com/accessToken");
+   *     
+   *     if (!response.ok) {
+   *       throw new Error(`Server responded with status ${response.status}`);
+   *     }
+   *     
+   *     const data = await response.json();
+   *     
+   *     // Extract the token and expiration from your server's response
+   *     const token = data.access_token;
+   *     const expiresIn = data.expires_in;
+   *
+   *     return { accessToken: token, expiresIn };
+   *   } catch (e) {
+   *     throw new Error("Failed to fetch access token: " + e);
+   *   }
+   * };
+   * 
+   * // This is where you supply the callback to the SDK
+   * PayEngineNative.setFetchAccessTokenCallback(fetchAccessToken);
+   * ```
+   *
+   * @param callback - A function that returns a `Promise<AccessToken>`. The function must handle
+   * errors properly in case token retrieval fails.
+   */
+
+
+  static async setFetchAccessTokenCallback(callback) {
+    PayEngineNative.fetchAccessTokenCallback = callback;
+
+    if (!PayEngineNative.isFetchCallbackListenerRegistered) {
+      PayEngineNative.emitter.addListener("fetchAccessToken", async () => {
+        try {
+          const result = await PayEngineNative.fetchAccessTokenCallback();
+          RNPayEngineNative.provideFetchAccessTokenResult(result);
+        } catch (error) {
+          RNPayEngineNative.provideFetchAccessTokenResult(null);
+        }
+      });
+      PayEngineNative.isFetchCallbackListenerRegistered = true;
+    }
+
+    RNPayEngineNative.configureFetchAccessTokenCallback();
+  }
+  /**
+   * Logs out the current merchant by invalidating the access token.
+   *
+   * @remarks
+   * While access tokens automatically expire, it's **strongly recommended** to explicitly invalidate
+   * them when a merchant's session ends on the server.
+   *
+   * Relying solely on token expiration can introduce **security vulnerabilities** 
+   * and result in a **suboptimal user experience**.
+   *
+   * Calling this method ensures that the merchant's session is terminated, 
+   * preventing any further authenticated requests until a new login is performed.
+   *
+   * For more details, refer to the official documentation:  
+   * [PayEngine Merchant Session](https://docs.payengine.co/merchant-session)
+   *
+   * ## Example Usage
+   * ```ts
+   * const merchantId = "your_merchant_id_here";
+   * await PayEngineNative.logout(merchantId);
+   * console.log("Merchant session terminated.");
+   * ```
+   *
+   * This ensures that no further authenticated requests can be made
+   * until a new access token is fetched.
+   *
+   * @param merchantId - The unique identifier of the merchant whose session should be invalidated.
+   * @returns A `Promise` indicating the completion of the logout process.
+   */
+
+
+  static async logout(merchantId) {
+    return RNPayEngineNative.logout(merchantId);
+  }
 
 }
 
 exports.default = PayEngineNative;
+
+_defineProperty(PayEngineNative, "emitter", new _reactNative.NativeEventEmitter(RNPEEventEmitter));
+
+_defineProperty(PayEngineNative, "isFetchCallbackListenerRegistered", false);
+
+_defineProperty(PayEngineNative, "fetchAccessTokenCallback", null);
 //# sourceMappingURL=PayEngineNative.js.map

package/lib/commonjs/components/v2/PayEngineNative.js.map

@@ -1 +1 @@
-{"version":3,"names":["RNPayEngineNative","NativeModules","PayEngineNative","createFraudMonitorSession","merchantId","getBrowserInfo","isPlatformPaySupported","Platform","OS","isApplePaySupported","isGooglePaySupported","userCanPay","provider","PayProvider","applePay","googlePay"],"sources":["PayEngineNative.tsx"],"sourcesContent":["import { NativeModules, Platform } from \"react-native\";\nimport { PayProvider } from \"../../interfaces\";\n\nconst { RNPayEngineNative } = NativeModules;\n\nexport default class PayEngineNative {\n  static async createFraudMonitorSession(merchantId: string) { \n    return RNPayEngineNative.createFraudMonitorSession(merchantId);\n  }\n\n  static async getBrowserInfo() {\n    return RNPayEngineNative.getBrowserInfo();\n  }\n\n  /**\n   * @deprecated use userCanPay instead\n   * @param merchantId \n   * @returns \n   */\n  static async isPlatformPaySupported(merchantId: string) {\n    if (Platform.OS === 'ios') {\n      return await RNPayEngineNative.isApplePaySupported(merchantId);\n    } else if (Platform.OS === 'android') {\n      return await RNPayEngineNative.isGooglePaySupported(merchantId);\n    }\n    return false;\n  }\n\n  static async userCanPay(provider: PayProvider, merchantId: string) {\n    if (provider == PayProvider.applePay && Platform.OS == 'ios') {\n      return await RNPayEngineNative.isApplePaySupported(merchantId);\n    } else if (provider === PayProvider.googlePay && Platform.OS === 'android') {\n      return await RNPayEngineNative.isGooglePaySupported(merchantId);\n    }\n    return false;\n  }\n}"],"mappings":";;;;;;;AAAA;;AACA;;AAEA,MAAM;EAAEA;AAAF,IAAwBC,0BAA9B;;AAEe,MAAMC,eAAN,CAAsB;EACG,aAAzBC,yBAAyB,CAACC,UAAD,EAAqB;IACzD,OAAOJ,iBAAiB,CAACG,yBAAlB,CAA4CC,UAA5C,CAAP;EACD;;EAE0B,aAAdC,cAAc,GAAG;IAC5B,OAAOL,iBAAiB,CAACK,cAAlB,EAAP;EACD;EAED;AACF;AACA;AACA;AACA;;;EACqC,aAAtBC,sBAAsB,CAACF,UAAD,EAAqB;IACtD,IAAIG,qBAAA,CAASC,EAAT,KAAgB,KAApB,EAA2B;MACzB,OAAO,MAAMR,iBAAiB,CAACS,mBAAlB,CAAsCL,UAAtC,CAAb;IACD,CAFD,MAEO,IAAIG,qBAAA,CAASC,EAAT,KAAgB,SAApB,EAA+B;MACpC,OAAO,MAAMR,iBAAiB,CAACU,oBAAlB,CAAuCN,UAAvC,CAAb;IACD;;IACD,OAAO,KAAP;EACD;;EAEsB,aAAVO,UAAU,CAACC,QAAD,EAAwBR,UAAxB,EAA4C;IACjE,IAAIQ,QAAQ,IAAIC,uBAAA,CAAYC,QAAxB,IAAoCP,qBAAA,CAASC,EAAT,IAAe,KAAvD,EAA8D;MAC5D,OAAO,MAAMR,iBAAiB,CAACS,mBAAlB,CAAsCL,UAAtC,CAAb;IACD,CAFD,MAEO,IAAIQ,QAAQ,KAAKC,uBAAA,CAAYE,SAAzB,IAAsCR,qBAAA,CAASC,EAAT,KAAgB,SAA1D,EAAqE;MAC1E,OAAO,MAAMR,iBAAiB,CAACU,oBAAlB,CAAuCN,UAAvC,CAAb;IACD;;IACD,OAAO,KAAP;EACD;;AA9BkC"}
+{"version":3,"names":["RNPayEngineNative","RNPEEventEmitter","NativeModules","PayEngineNative","constructor","createFraudMonitorSession","merchantId","getBrowserInfo","isPlatformPaySupported","Platform","OS","isApplePaySupported","isGooglePaySupported","userCanPay","provider","PayProvider","applePay","googlePay","setFetchAccessTokenCallback","callback","fetchAccessTokenCallback","isFetchCallbackListenerRegistered","emitter","addListener","result","provideFetchAccessTokenResult","error","configureFetchAccessTokenCallback","logout","NativeEventEmitter"],"sources":["PayEngineNative.tsx"],"sourcesContent":["import { NativeEventEmitter, NativeModules, Platform } from \"react-native\";\nimport { PayProvider } from \"../../interfaces\";\n\nconst { RNPayEngineNative, RNPEEventEmitter } = NativeModules;\n\n/**\n * Represents an access token used for authenticating with the PayEngine SDK.\n *\n * @remarks\n * The access token contains the actual token string and the duration (in seconds)\n * for which the token remains valid. This is typically retrieved from your backend\n * and used for making authenticated requests.\n *\n * @property accessToken - The access token string.\n * @property expiresIn - The time (in seconds) until the token expires.\n *  \n * @category PayEngine\n */\nexport type AccessToken = {\n  accessToken: string;\n  expiresIn: number;\n};\n\n/**\n * A callback function that provides an access token to the PayEngine SDK.\n *\n * @returns A promise resolving to a valid {@link AccessToken}.\n * \n * @category PayEngine\n */\nexport type FetchAccessTokenCallback = () => Promise<AccessToken>;\n\n/**\n * Provides an interface for interacting with the native PayEngine SDK.\n *\n * @remarks\n * `PayEngineNative` acts as a bridge between your React Native JavaScript code and\n * the native PayEngine SDKs on iOS and Android. It utilizes React Native's\n * Native Modules and platform channels to enable core payment functionalities.\n *\n * These include:\n * - Fraud monitoring\n * - Browser/device info retrieval\n * - Support detection for Apple Pay and Google Pay\n *\n *\n * @category PayEngine\n */\nexport default class PayEngineNative {\n  private static emitter = new NativeEventEmitter(RNPEEventEmitter);\n\n  private static isFetchCallbackListenerRegistered = false;\n\n  private static fetchAccessTokenCallback: FetchAccessTokenCallback | null = null;\n\n\n  private constructor() { }\n\n  /**\n   * Retrieves a fraud monitoring session ID from the native PayEngine SDK.\n   *\n   *\n   * @param merchantId - The unique identifier for the merchant.\n   * @returns A `Promise<string>` containing the fraud monitoring session ID.\n   */\n  static async createFraudMonitorSession(merchantId: string): Promise<string> {\n    return RNPayEngineNative.createFraudMonitorSession(merchantId);\n  }\n\n  /**\n   * Retrieves browser-related information from the native PayEngine SDK.\n   *\n   * @returns A `Promise<string>` containing browser and device details.\n   *\n   */\n  static async getBrowserInfo(): Promise<string> {\n    return RNPayEngineNative.getBrowserInfo();\n  }\n\n  /**\n   * @deprecated Use {@link PayEngineNative.userCanPay} instead.\n   *\n   * Checks if platform-native payments (Apple Pay or Google Pay) are supported on the current device.\n   *\n   * @remarks\n   * This method has been deprecated in favor of {@link PayEngineNative.userCanPay}, which allows specifying\n   * the payment provider explicitly.\n   *\n   * @param merchantId - The unique identifier for the merchant.\n   * @returns A `Promise<boolean>` indicating whether the platform-specific payment method is supported.\n   *\n   */\n  static async isPlatformPaySupported(merchantId: string): Promise<boolean> {\n    if (Platform.OS === 'ios') {\n      return await RNPayEngineNative.isApplePaySupported(merchantId);\n    } else if (Platform.OS === 'android') {\n      return await RNPayEngineNative.isGooglePaySupported(merchantId);\n    }\n    return false;\n  }\n\n  /**\n   * Checks if the user can make payments using Apple Pay (iOS) or Google Pay (Android).\n   *\n   * @remarks\n   * This method verifies whether the current device and platform support the selected payment provider.\n   * It performs a platform-specific check using the native PayEngine SDK for either Apple Pay or Google Pay.\n   *\n   * ## Supported Providers\n   * - `PayProvider.googlePay` (Android only)\n   * - `PayProvider.applePay` (iOS only)\n   *\n   * @param provider - The payment provider to check support for.\n   * @param merchantId - The unique identifier for the merchant.\n   * @returns A `Promise<boolean>` indicating whether the selected payment method is supported.\n   */\n  static async userCanPay(provider: PayProvider, merchantId: string): Promise<boolean> {\n    if (provider == PayProvider.applePay && Platform.OS == 'ios') {\n      return await RNPayEngineNative.isApplePaySupported(merchantId);\n    } else if (provider === PayProvider.googlePay && Platform.OS === 'android') {\n      return await RNPayEngineNative.isGooglePaySupported(merchantId);\n    }\n    return false;\n  }\n\n\n  /**\n   * Sets the callback function that provides an access token when required by PayEngine.\n   *\n   * @remarks\n   * When the PayEngine SDK needs an access token, it will call this callback function\n   * to request the host application to fetch a new token from its backend.\n   * \n   * The SDK uses this token internally to make calls to merchant related APIs which require merchant's credentials.\n   *\n   * ## Important:\n   * - PayEngine will invoke this callback **whenever an access token is needed or needs to be refreshed**.\n   * - The integrator must ensure that the token retrieval logic is secure and efficient in their backend.\n   * - For more details on how to retrieve the access token from Payengine, refer to the official documentation:\n   *   [PayEngine Merchant Session](https://docs.payengine.co/merchant-session#obtaining-a-new-merchant-session)\n   *\n   * ## Example Usage\n   * ```ts\n   * const fetchAccessToken = async (): Promise<AccessToken> => {\n   *   try {\n   *     // Make a network request to your server to fetch the token\n   *     // Your server then makes a request to Payengine securely and returns the results back in response\n   *     const response = await fetch(\"https://yourserver.com/accessToken\");\n   *     \n   *     if (!response.ok) {\n   *       throw new Error(`Server responded with status ${response.status}`);\n   *     }\n   *     \n   *     const data = await response.json();\n   *     \n   *     // Extract the token and expiration from your server's response\n   *     const token = data.access_token;\n   *     const expiresIn = data.expires_in;\n   *\n   *     return { accessToken: token, expiresIn };\n   *   } catch (e) {\n   *     throw new Error(\"Failed to fetch access token: \" + e);\n   *   }\n   * };\n   * \n   * // This is where you supply the callback to the SDK\n   * PayEngineNative.setFetchAccessTokenCallback(fetchAccessToken);\n   * ```\n   *\n   * @param callback - A function that returns a `Promise<AccessToken>`. The function must handle\n   * errors properly in case token retrieval fails.\n   */\n  static async setFetchAccessTokenCallback(callback: FetchAccessTokenCallback) {\n    PayEngineNative.fetchAccessTokenCallback = callback;\n\n    if (!PayEngineNative.isFetchCallbackListenerRegistered) {\n      PayEngineNative.emitter.addListener(\"fetchAccessToken\", async () => {\n        try {\n          const result = await PayEngineNative.fetchAccessTokenCallback!();\n          RNPayEngineNative.provideFetchAccessTokenResult(result);\n        } catch (error) {\n          RNPayEngineNative.provideFetchAccessTokenResult(null);\n        }\n      });\n      PayEngineNative.isFetchCallbackListenerRegistered = true;\n    }\n\n\n    RNPayEngineNative.configureFetchAccessTokenCallback();\n  }\n\n  /**\n   * Logs out the current merchant by invalidating the access token.\n   *\n   * @remarks\n   * While access tokens automatically expire, it's **strongly recommended** to explicitly invalidate\n   * them when a merchant's session ends on the server.\n   *\n   * Relying solely on token expiration can introduce **security vulnerabilities** \n   * and result in a **suboptimal user experience**.\n   *\n   * Calling this method ensures that the merchant's session is terminated, \n   * preventing any further authenticated requests until a new login is performed.\n   *\n   * For more details, refer to the official documentation:  \n   * [PayEngine Merchant Session](https://docs.payengine.co/merchant-session)\n   *\n   * ## Example Usage\n   * ```ts\n   * const merchantId = \"your_merchant_id_here\";\n   * await PayEngineNative.logout(merchantId);\n   * console.log(\"Merchant session terminated.\");\n   * ```\n   *\n   * This ensures that no further authenticated requests can be made\n   * until a new access token is fetched.\n   *\n   * @param merchantId - The unique identifier of the merchant whose session should be invalidated.\n   * @returns A `Promise` indicating the completion of the logout process.\n   */\n  static async logout(merchantId: string): Promise<void> {\n    return RNPayEngineNative.logout(merchantId);\n  }\n}"],"mappings":";;;;;;;AAAA;;AACA;;;;AAEA,MAAM;EAAEA,iBAAF;EAAqBC;AAArB,IAA0CC,0BAAhD;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,MAAMC,eAAN,CAAsB;EAQ3BC,WAAW,GAAG,CAAG;EAEzB;AACF;AACA;AACA;AACA;AACA;AACA;;;EACwC,aAAzBC,yBAAyB,CAACC,UAAD,EAAsC;IAC1E,OAAON,iBAAiB,CAACK,yBAAlB,CAA4CC,UAA5C,CAAP;EACD;EAED;AACF;AACA;AACA;AACA;AACA;;;EAC6B,aAAdC,cAAc,GAAoB;IAC7C,OAAOP,iBAAiB,CAACO,cAAlB,EAAP;EACD;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;EACqC,aAAtBC,sBAAsB,CAACF,UAAD,EAAuC;IACxE,IAAIG,qBAAA,CAASC,EAAT,KAAgB,KAApB,EAA2B;MACzB,OAAO,MAAMV,iBAAiB,CAACW,mBAAlB,CAAsCL,UAAtC,CAAb;IACD,CAFD,MAEO,IAAIG,qBAAA,CAASC,EAAT,KAAgB,SAApB,EAA+B;MACpC,OAAO,MAAMV,iBAAiB,CAACY,oBAAlB,CAAuCN,UAAvC,CAAb;IACD;;IACD,OAAO,KAAP;EACD;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;EACyB,aAAVO,UAAU,CAACC,QAAD,EAAwBR,UAAxB,EAA8D;IACnF,IAAIQ,QAAQ,IAAIC,uBAAA,CAAYC,QAAxB,IAAoCP,qBAAA,CAASC,EAAT,IAAe,KAAvD,EAA8D;MAC5D,OAAO,MAAMV,iBAAiB,CAACW,mBAAlB,CAAsCL,UAAtC,CAAb;IACD,CAFD,MAEO,IAAIQ,QAAQ,KAAKC,uBAAA,CAAYE,SAAzB,IAAsCR,qBAAA,CAASC,EAAT,KAAgB,SAA1D,EAAqE;MAC1E,OAAO,MAAMV,iBAAiB,CAACY,oBAAlB,CAAuCN,UAAvC,CAAb;IACD;;IACD,OAAO,KAAP;EACD;EAGD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;EAC0C,aAA3BY,2BAA2B,CAACC,QAAD,EAAqC;IAC3EhB,eAAe,CAACiB,wBAAhB,GAA2CD,QAA3C;;IAEA,IAAI,CAAChB,eAAe,CAACkB,iCAArB,EAAwD;MACtDlB,eAAe,CAACmB,OAAhB,CAAwBC,WAAxB,CAAoC,kBAApC,EAAwD,YAAY;QAClE,IAAI;UACF,MAAMC,MAAM,GAAG,MAAMrB,eAAe,CAACiB,wBAAhB,EAArB;UACApB,iBAAiB,CAACyB,6BAAlB,CAAgDD,MAAhD;QACD,CAHD,CAGE,OAAOE,KAAP,EAAc;UACd1B,iBAAiB,CAACyB,6BAAlB,CAAgD,IAAhD;QACD;MACF,CAPD;MAQAtB,eAAe,CAACkB,iCAAhB,GAAoD,IAApD;IACD;;IAGDrB,iBAAiB,CAAC2B,iCAAlB;EACD;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;EACqB,aAANC,MAAM,CAACtB,UAAD,EAAoC;IACrD,OAAON,iBAAiB,CAAC4B,MAAlB,CAAyBtB,UAAzB,CAAP;EACD;;AA9KkC;;;;gBAAhBH,e,aACM,IAAI0B,+BAAJ,CAAuB5B,gBAAvB,C;;gBADNE,e,uCAGgC,K;;gBAHhCA,e,8BAKwD,I"}

package/lib/commonjs/components/v2/PayEngineProvider.js

@@ -17,6 +17,58 @@ const {
   RNPayEngineNative
 } = _reactNative.NativeModules;
 const PayEngineContext = /*#__PURE__*/(0, _react.createContext)(undefined);
+/**
+ * A provider that initializes and manages PayEngine's configuration across the app.
+ *
+ * `PayEngineProvider` ensures that PayEngine's SDK is properly set up by loading
+ * the necessary configurations before rendering the app. It must wrap the root widget
+ * for the payment functionalities to work correctly.
+ *
+ * ## Usage
+ *
+ * Before using PayEngine in your application, wrap your app inside [PayEngineProvider]
+ * and pass an `IPayEngineConfig` instance containing your public key, script URL, and optional log level.
+ *
+ * ```tsx
+ * const PE_CONFIG: IPayEngineConfig = {
+ *   publicKey: PUBLIC_KEY,
+ *   scriptURL: "https://staging-sandbox.payengine.dev/",
+ *   logLevel: 1,
+ * };
+ *
+ * return (
+ *   <PayEngineProvider config={PE_CONFIG}>
+ *     <NavigationContainer>
+ *       <DrawerNavigator />
+ *     </NavigationContainer>
+ *   </PayEngineProvider>
+ * );
+ * ```
+ *
+ * ## How It Works
+ *
+ * 1. The `PayEngineProvider` component accepts a configuration object (`IPayEngineConfig`) containing 
+ *    the `publicKey`, `scriptURL`, and `logLevel`.
+ * 2. It initializes the PayEngine SDK with the `publicKey` 
+ *    and `scriptURL` from the configuration.
+ * 3. The provider uses the `React.useEffect` hook to ensure that the configuration is set up 
+ *    before rendering the children.
+ * 4. While loading the configuration, an `ActivityIndicator` is displayed. Once the SDK is set up, 
+ *    it renders the provided child components.
+ *
+ * ## Properties:
+ *
+ * - **`config`**: The configuration required for PayEngine (type: `IPayEngineConfig`).
+ *   - `publicKey`: The public key for authentication.
+ *   - `scriptURL`: The URL for the PayEngine script.
+ *   - `logLevel`: The log level for debugging (optional).
+ *
+ * - **`children`**: The child components or widgets to be rendered after PayEngine is initialized.
+ *
+ *
+ * @category SecureFields
+ */
+
 exports.PayEngineContext = PayEngineContext;
 
 const PayEngineProvider = _ref => {

package/lib/commonjs/components/v2/PayEngineProvider.js.map

@@ -1 +1 @@
-{"version":3,"names":["RNPayEngineNative","NativeModules","PayEngineContext","createContext","undefined","PayEngineProvider","config","children","loading","setLoading","React","useState","useEffect","setConfig","publicKey","scriptURL","Error"],"sources":["PayEngineProvider.tsx"],"sourcesContent":["import React, { createContext } from \"react\";\nimport type { IPayEngineConfig } from \"../../interfaces\";\nimport { ActivityIndicator, NativeModules } from \"react-native\";\n\nconst { RNPayEngineNative } = NativeModules;\n\nconst PayEngineContext = createContext<IPayEngineConfig | undefined>(undefined);\n\nconst PayEngineProvider = ({ config, children }: { config: IPayEngineConfig, children: React.ReactNode }) => {\n  const [loading, setLoading] = React.useState(true);\n\n  React.useEffect(() => {\n    setLoading(true);\n    RNPayEngineNative.setConfig(config.publicKey, config.scriptURL)\n    setLoading(false);\n  }, [config]);\n\n  if (!config) {\n    throw new Error('PayEngineProvider: config is required');\n  }\n\n  return <PayEngineContext.Provider value={config}>\n    {loading ? <ActivityIndicator /> : children}\n  </PayEngineContext.Provider>\n}\n\nexport {\n  PayEngineContext,\n  PayEngineProvider\n};"],"mappings":";;;;;;;AAAA;;AAEA;;;;;;AAEA,MAAM;EAAEA;AAAF,IAAwBC,0BAA9B;AAEA,MAAMC,gBAAgB,gBAAG,IAAAC,oBAAA,EAA4CC,SAA5C,CAAzB;;;AAEA,MAAMC,iBAAiB,GAAG,QAAmF;EAAA,IAAlF;IAAEC,MAAF;IAAUC;EAAV,CAAkF;;EAC3G,MAAM,CAACC,OAAD,EAAUC,UAAV,IAAwBC,cAAA,CAAMC,QAAN,CAAe,IAAf,CAA9B;;EAEAD,cAAA,CAAME,SAAN,CAAgB,MAAM;IACpBH,UAAU,CAAC,IAAD,CAAV;IACAT,iBAAiB,CAACa,SAAlB,CAA4BP,MAAM,CAACQ,SAAnC,EAA8CR,MAAM,CAACS,SAArD;IACAN,UAAU,CAAC,KAAD,CAAV;EACD,CAJD,EAIG,CAACH,MAAD,CAJH;;EAMA,IAAI,CAACA,MAAL,EAAa;IACX,MAAM,IAAIU,KAAJ,CAAU,uCAAV,CAAN;EACD;;EAED,oBAAO,6BAAC,gBAAD,CAAkB,QAAlB;IAA2B,KAAK,EAAEV;EAAlC,GACJE,OAAO,gBAAG,6BAAC,8BAAD,OAAH,GAA2BD,QAD9B,CAAP;AAGD,CAhBD"}
+{"version":3,"names":["RNPayEngineNative","NativeModules","PayEngineContext","createContext","undefined","PayEngineProvider","config","children","loading","setLoading","React","useState","useEffect","setConfig","publicKey","scriptURL","Error"],"sources":["PayEngineProvider.tsx"],"sourcesContent":["import React, { createContext } from \"react\";\nimport type { IPayEngineConfig } from \"../../interfaces\";\nimport { ActivityIndicator, NativeModules } from \"react-native\";\n\nconst { RNPayEngineNative } = NativeModules;\n\nconst PayEngineContext = createContext<IPayEngineConfig | undefined>(undefined);\n\n/**\n * A provider that initializes and manages PayEngine's configuration across the app.\n *\n * `PayEngineProvider` ensures that PayEngine's SDK is properly set up by loading\n * the necessary configurations before rendering the app. It must wrap the root widget\n * for the payment functionalities to work correctly.\n *\n * ## Usage\n *\n * Before using PayEngine in your application, wrap your app inside [PayEngineProvider]\n * and pass an `IPayEngineConfig` instance containing your public key, script URL, and optional log level.\n *\n * ```tsx\n * const PE_CONFIG: IPayEngineConfig = {\n *   publicKey: PUBLIC_KEY,\n *   scriptURL: \"https://staging-sandbox.payengine.dev/\",\n *   logLevel: 1,\n * };\n *\n * return (\n *   <PayEngineProvider config={PE_CONFIG}>\n *     <NavigationContainer>\n *       <DrawerNavigator />\n *     </NavigationContainer>\n *   </PayEngineProvider>\n * );\n * ```\n *\n * ## How It Works\n *\n * 1. The `PayEngineProvider` component accepts a configuration object (`IPayEngineConfig`) containing \n *    the `publicKey`, `scriptURL`, and `logLevel`.\n * 2. It initializes the PayEngine SDK with the `publicKey` \n *    and `scriptURL` from the configuration.\n * 3. The provider uses the `React.useEffect` hook to ensure that the configuration is set up \n *    before rendering the children.\n * 4. While loading the configuration, an `ActivityIndicator` is displayed. Once the SDK is set up, \n *    it renders the provided child components.\n *\n * ## Properties:\n *\n * - **`config`**: The configuration required for PayEngine (type: `IPayEngineConfig`).\n *   - `publicKey`: The public key for authentication.\n *   - `scriptURL`: The URL for the PayEngine script.\n *   - `logLevel`: The log level for debugging (optional).\n *\n * - **`children`**: The child components or widgets to be rendered after PayEngine is initialized.\n *\n *\n * @category SecureFields\n */\nconst PayEngineProvider = ({ config, children }: { config: IPayEngineConfig, children: React.ReactNode }) => {\n  const [loading, setLoading] = React.useState(true);\n\n  React.useEffect(() => {\n    setLoading(true);\n    RNPayEngineNative.setConfig(config.publicKey, config.scriptURL)\n    setLoading(false);\n  }, [config]);\n\n  if (!config) {\n    throw new Error('PayEngineProvider: config is required');\n  }\n\n  return <PayEngineContext.Provider value={config}>\n    {loading ? <ActivityIndicator /> : children}\n  </PayEngineContext.Provider>\n};\n\nexport {\n  PayEngineContext,\n  PayEngineProvider\n};"],"mappings":";;;;;;;AAAA;;AAEA;;;;;;AAEA,MAAM;EAAEA;AAAF,IAAwBC,0BAA9B;AAEA,MAAMC,gBAAgB,gBAAG,IAAAC,oBAAA,EAA4CC,SAA5C,CAAzB;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;AACA,MAAMC,iBAAiB,GAAG,QAAmF;EAAA,IAAlF;IAAEC,MAAF;IAAUC;EAAV,CAAkF;;EAC3G,MAAM,CAACC,OAAD,EAAUC,UAAV,IAAwBC,cAAA,CAAMC,QAAN,CAAe,IAAf,CAA9B;;EAEAD,cAAA,CAAME,SAAN,CAAgB,MAAM;IACpBH,UAAU,CAAC,IAAD,CAAV;IACAT,iBAAiB,CAACa,SAAlB,CAA4BP,MAAM,CAACQ,SAAnC,EAA8CR,MAAM,CAACS,SAArD;IACAN,UAAU,CAAC,KAAD,CAAV;EACD,CAJD,EAIG,CAACH,MAAD,CAJH;;EAMA,IAAI,CAACA,MAAL,EAAa;IACX,MAAM,IAAIU,KAAJ,CAAU,uCAAV,CAAN;EACD;;EAED,oBAAO,6BAAC,gBAAD,CAAkB,QAAlB;IAA2B,KAAK,EAAEV;EAAlC,GACJE,OAAO,gBAAG,6BAAC,8BAAD,OAAH,GAA2BD,QAD9B,CAAP;AAGD,CAhBD"}

package/lib/commonjs/components/v2/SecureFields/BankAccountView.js

@@ -21,6 +21,77 @@ const RNPEBankAccountView = (0, _reactNative.requireNativeComponent)(COMPONENT_N
 
 const RNPEBankAccountViewManager = _reactNative.UIManager[COMPONENT_NAME];
 const peEventEmitter = new _reactNative.NativeEventEmitter(RNPEEventEmitter);
+/**
+ * Props for the `PEBankAccountView` component.
+ *
+ * Allows optional configuration of additional input fields that can be rendered
+ * alongside the standard bank account fields.
+ *
+ * These fields can be used to collect extra information such as account holder type,
+ * billing address, or custom metadata required by the merchant.
+ *
+ * @category SecureFields
+ *
+ * @example
+ * ```ts
+ * const fields: IPEField[] = [
+ *   {
+ *     name: "accountHolderType",
+ *     type: "text",
+ *     placeholder: "Account Holder Type",
+ *     keyboardType: PEKeyboardType.Alphabet,
+ *     isRequired: false
+ *   }
+ * ];
+ *
+ * <PEBankAccountView additionalFields={fields} />
+ * ```
+ */
+
+/**
+ * A secure form widget for entering a customer's bank account information.
+ *
+ * [PEBankAccountView] provides a UI component for securely collecting bank account details.
+ * It does not store data locally and instead tokenizes the information using PayEngine.
+ *
+ * ## Features:
+ * - Securely collects bank account details.
+ * - Supports additional customizable fields.
+ * - Provides methods to show/hide the keyboard.
+ * - Allows tokenizing the entered data for safe storage.
+ *
+ * ## Usage Example:
+ *
+ * ```tsx
+ * const formRef = React.createRef<PEBankAccountViewMethods>();
+ *
+ * return (
+ *   <View style={styles.container}>
+ *     <Text>Welcome to PayEngine React Native SDK example</Text>
+ *     <View style={{ width: '100%' }}>
+ *       <PEBankAccountView ref={formRef} />
+ *       <Button disabled={submitting} onPress={() => createBankAccount()} title="Create Bank Account" />
+ *     </View>
+ *     <ScrollView style={{ flex: 1, width: '100%', backgroundColor: 'lightyellow', padding: 10, marginVertical: 20 }}>
+ *       <Text>{JSON.stringify(secureFieldsResult, null, 4)}</Text>
+ *     </ScrollView>
+ *   </View>
+ * );
+ * ```
+ *
+ * ## How It Works:
+ * 1. Create an instance of [PEBankAccountView], optionally passing additional fields.
+ * 2. Display the form inside your widget tree.
+ * 3. Use [showKeyboard] and [hideKeyboard] to manage input focus.
+ * 4. Call [submit] to securely send the bank account data and receive a token.
+ *
+ * ## Methods:
+ * - **`showKeyboard()`**: Manually shows the on-screen keyboard.
+ * - **`hideKeyboard()`**: Hides the on-screen keyboard.
+ * - **`submit()`**: Submits the entered data and retrieves a tokenized version of the bank account data.
+ *
+ * @category SecureFields
+ */
 const PEBankAccountView = /*#__PURE__*/React.forwardRef((props, ref) => {
   const formRef = React.useRef();
   const [height, setHeight] = React.useState(0);