@dev_innovations_labs/phonepe-pg-sdk 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,204 @@
+📱 PhonePe PG SDK
+@dev_innovations_labs/phonepe-pg-sdk
+<p align="center"> A unified PhonePe Payment Gateway SDK for <b>Node.js</b>, <b>React Web</b>, and <b>React Native</b> using the latest Checkout v2 APIs. </p> <p align="center"> <img src="https://img.shields.io/npm/v/@dev_innovations_labs/phonepe-pg-sdk?color=blue&style=for-the-badge" /> <img src="https://img.shields.io/npm/dm/@dev_innovations_labs/phonepe-pg-sdk?style=for-the-badge" /> <img src="https://img.shields.io/badge/PhonePe-PG%20SDK-purple?style=for-the-badge" /> </p>
+
+------------------------------------------------------------------------
+
+# 🖼️ Screenshots
+
+### 🌐 Web Checkout
+
+![Web
+Checkout](https://dummyimage.com/800x400/000/fff&text=Web+Checkout+Preview)
+
+### 📱 React Native Checkout
+
+![React Native
+Checkout](https://dummyimage.com/800x400/333/fff&text=React+Native+WebView+Checkout)
+
+------------------------------------------------------------------------
+
+# 🚀 Features
+
+-   🔐 OAuth Token Generation (Checkout v2)
+-   💳 Initiate Payments (Web, Mobile, UPI, Cards)
+-   🔄 WebView Support for React Native
+-   🧪 Status Check API
+-   🌍 Sandbox & Production Environments
+-   🎯 TypeScript Fully Supported
+-   🧩 Multi-platform Unified SDK
+-   🧵 Auto-environment normalization
+
+------------------------------------------------------------------------
+
+# 📦 Installation
+
+``` bash
+npm install @dev_innovations_labs/phonepe-pg-sdk
+```
+
+------------------------------------------------------------------------
+
+# ⚙️ Environments
+
+  Input                          Interpreted As
+  ------------------------------ ----------------
+  production, Production, prod   production
+  sandbox, Sandbox, SANDBOX      sandbox
+
+------------------------------------------------------------------------
+
+# 📚 Usage
+
+------------------------------------------------------------------------
+
+## 🟦 1. Node.js Example
+
+``` ts
+import { PhonePeNode } from "@dev_innovations_labs/phonepe-pg-sdk";
+
+const phonepe = new PhonePeNode({
+  clientId: "YOUR_CLIENT_ID",
+  clientSecret: "YOUR_SECRET",
+  environment: "production"
+});
+
+const res = await phonepe.createPayment({
+  merchantId: "M123",
+  merchantOrderId: "uuid-123",
+  amount: 10000,
+  redirectUrl: "https://yourapp.com/redirect",
+  callbackUrl: "https://yourapp.com/callback"
+});
+
+console.log(res.redirectUrl);
+```
+
+------------------------------------------------------------------------
+
+## 🌐 2. React Web Example
+
+``` jsx
+import { PhonePeCheckoutWeb } from "@dev_innovations_labs/phonepe-pg-sdk";
+
+export default function Checkout() {
+  return (
+    <PhonePeCheckoutWeb
+      environment="sandbox"
+      clientId="YOUR_CLIENT_ID"
+      clientSecret="YOUR_SECRET"
+      request={{
+        merchantId: "M123",
+        merchantOrderId: "uuid-321",
+        amount: 10000,
+        redirectUrl: "https://yourapp.com/redirect",
+        callbackUrl: "https://yourapp.com/callback"
+      }}
+      onSuccess={(r) => console.log("Success", r)}
+      onError={(e) => console.log("Error", e)}
+    />
+  );
+}
+```
+
+------------------------------------------------------------------------
+
+## 📱 3. React Native Example
+
+``` jsx
+import { PhonePeCheckoutNative } from "@dev_innovations_labs/phonepe-pg-sdk/native";
+
+export default function App() {
+  return (
+    <PhonePeCheckoutNative
+      environment="production"
+      clientId="YOUR_CLIENT_ID"
+      clientSecret="YOUR_SECRET"
+      request={{
+        merchantId: "M123",
+        merchantOrderId: "uuid-xyz",
+        amount: 10000,
+        redirectUrl: "https://yourapp.com/redirect",
+        callbackUrl: "https://yourapp.com/callback"
+      }}
+      onSuccess={(data) => console.log("Success", data)}
+      onError={(e) => console.log("Error", e)}
+    />
+  );
+}
+```
+
+------------------------------------------------------------------------
+
+# 📡 Status API
+
+``` ts
+const status = await phonepe.checkStatus("uuid-1234");
+console.log(status);
+```
+
+------------------------------------------------------------------------
+
+# 📘 API Table
+
+  API                        Platform       Description
+  -------------------------- -------------- -------------------------------
+  `createPayment()`          Node/Web/RN    Initiates PhonePe Checkout v2
+  `checkStatus()`            Node           Checks transaction status
+  `PhonePeCheckoutWeb`       React Web      In-App iFrame Checkout
+  `PhonePeCheckoutNative`    React Native   Mobile WebView Checkout
+  `normalizeEnvironment()`   Internal       Normalizes env strings
+
+------------------------------------------------------------------------
+
+# 🧩 Folder Structure
+
+    src/
+      index.ts
+      native.ts
+      PhonePeNode.ts
+      PhonePeReact.tsx
+      PhonePeReactNative.tsx
+      utils.ts
+      types.ts
+    dist/
+
+------------------------------------------------------------------------
+
+# 🏗 Roadmap
+
+-   [ ] Add PhonePe payouts API
+-   [ ] Add checksum support for PG v1
+-   [ ] Add UI components for receipts
+-   [ ] Add webhooks helpers
+
+------------------------------------------------------------------------
+
+# 👨‍💻 Contributors
+
+  Name                    Role
+  ----------------------- ----------------
+  Dev Innovations Labs    Lead Developer
+  Open Source Community   Coming Soon
+
+------------------------------------------------------------------------
+
+# 📝 Changelog
+
+### v1.0.0
+
+-   Initial release\
+-   Multi-platform SDK\
+-   React Web + RN support\
+-   Token + Payment + Status APIs\
+-   Normalized environment handling
+
+------------------------------------------------------------------------
+
+# 📄 License
+
+MIT © Dev Innovations Labs
+
+```{=html}
+</div>
+```

package/dist/PhonePeReact.d.ts

@@ -1,5 +1,4 @@
-import React from "react";
-import { PhonePeCredentials, PhonePePaymentInit } from "./types";
+import { PhonePePaymentInit, PhonePeCredentials } from "./types";
 declare global {
     interface Window {
         PhonePeCheckout: any;
@@ -7,8 +6,8 @@ declare global {
 }
 interface Props extends PhonePeCredentials {
     request: PhonePePaymentInit;
-    onSuccess: (data: any) => void;
-    onError: (err: any) => void;
+    onSuccess: (d: any) => void;
+    onError: (e: any) => void;
 }
-export declare const PhonePeCheckoutWeb: React.FC<Props>;
+export declare const PhonePeCheckoutWeb: ({ clientId, clientSecret, environment, request, onSuccess, onError }: Props) => any;
 export {};

package/dist/PhonePeReactNative.d.ts

@@ -1,9 +1,8 @@
-import React from "react";
-import { PhonePeCredentials, PhonePePaymentInit } from "./types";
+import { PhonePePaymentInit, PhonePeCredentials } from "./types";
 interface Props extends PhonePeCredentials {
     request: PhonePePaymentInit;
-    onSuccess: (data: any) => void;
-    onError: (err: any) => void;
+    onSuccess: (d: any) => void;
+    onError: (e: any) => void;
 }
-export declare const PhonePeCheckoutNative: React.FC<Props>;
+export declare const PhonePeCheckoutNative: ({ clientId, clientSecret, environment, request, onSuccess, onError }: Props) => any;
 export {};

package/dist/index.esm.js

@@ -7,13 +7,13 @@ const PhonePeUrls = {
         token: "https://api.phonepe.com/apis/identity-manager/v1/oauth/token",
         pay: "https://api.phonepe.com/apis/pg/checkout/v2/pay",
         status: "https://api.phonepe.com/apis/pg/checkout/v2/order/status",
-        script: "https://mercury.phonepe.com/web/bundle/checkout.js",
+        script: "https://mercury.phonepe.com/web/bundle/checkout.js"
     },
     sandbox: {
         token: "https://api-preprod.phonepe.com/apis/identity-manager/v1/oauth/token",
         pay: "https://api-preprod.phonepe.com/apis/pg-sandbox/checkout/v2/pay",
         status: "https://api-preprod.phonepe.com/apis/pg-sandbox/checkout/v2/order/status",
-        script: "https://mercury.phonepe.com/web/bundle/checkout.js",
+        script: "https://mercury.phonepe.com/web/bundle/checkout.js"
     }
 };
 
@@ -23,7 +23,7 @@ function normalizeEnvironment(env) {
         return "production";
     if (e === "sandbox")
         return "sandbox";
-    throw new Error(`Invalid environment "${env}". Expected "Production" or "Sandbox".`);
+    throw new Error(`Invalid environment: ${env}`);
 }
 
 class PhonePeNode {
@@ -31,8 +31,7 @@ class PhonePeNode {
         this.creds = creds;
     }
     get urls() {
-        const env = normalizeEnvironment(this.creds.environment);
-        return PhonePeUrls[env];
+        return PhonePeUrls[normalizeEnvironment(this.creds.environment)];
     }
     async getToken() {
         const body = new URLSearchParams({
@@ -42,59 +41,46 @@ class PhonePeNode {
             client_version: "1"
         });
         const res = await axios.post(this.urls.token, body, {
-            headers: { "Content-Type": "application/x-www-form-urlencoded" },
+            headers: { "Content-Type": "application/x-www-form-urlencoded" }
         });
         return res.data.access_token;
     }
     async createPayment(data) {
         const token = await this.getToken();
         const payload = {
-            merchantId: data.merchantId,
+            ...data,
             merchantOrderId: v4(),
-            merchantTransactionId: v4(),
-            amount: data.amount,
-            mobileNumber: data.mobileNumber,
-            redirectUrl: data.redirectUrl,
-            callbackUrl: data.callbackUrl,
-            deviceContext: data.deviceContext,
-            paymentScope: data.paymentScope,
+            merchantTransactionId: v4()
         };
         const res = await axios.post(this.urls.pay, payload, {
             headers: {
                 "Content-Type": "application/json",
-                Authorization: `O-Bearer ${token}`,
+                Authorization: `O-Bearer ${token}`
             }
         });
         return res.data;
     }
     async getStatus(merchantId, merchantOrderId) {
         const token = await this.getToken();
-        const res = await axios.post(this.urls.status, {
-            merchantId,
-            merchantOrderId
-        }, {
+        const res = await axios.post(this.urls.status, { merchantId, merchantOrderId }, {
             headers: {
                 "Content-Type": "application/json",
-                Authorization: `O-Bearer ${token}`,
+                Authorization: `O-Bearer ${token}`
             }
         });
         return res.data;
     }
 }
 
-const PhonePeCheckoutWeb = ({ environment, clientId, clientSecret, request, onSuccess, onError }) => {
-    const env = normalizeEnvironment(environment);
-    const urls = PhonePeUrls[env];
-    if (!urls) {
-        onError(`Invalid environment: ${environment}`);
-        return;
-    }
+const PhonePeCheckoutWeb = ({ clientId, clientSecret, environment, request, onSuccess, onError }) => {
+    const urls = PhonePeUrls[normalizeEnvironment(environment)];
     useEffect(() => {
         const script = document.createElement("script");
         script.src = urls.script;
         script.async = true;
         document.body.appendChild(script);
         script.onload = () => init();
+        return () => document.body.removeChild(script);
     }, []);
     const init = async () => {
         try {
@@ -114,7 +100,7 @@ const PhonePeCheckoutWeb = ({ environment, clientId, clientSecret, request, onSu
                 merchantOrderId: v4(),
                 merchantTransactionId: v4()
             };
-            const payResp = await fetch(urls.pay, {
+            const resp = await fetch(urls.pay, {
                 method: "POST",
                 headers: {
                     "Content-Type": "application/json",
@@ -122,11 +108,11 @@ const PhonePeCheckoutWeb = ({ environment, clientId, clientSecret, request, onSu
                 },
                 body: JSON.stringify(payload)
             });
-            const payData = await payResp.json();
+            const data = await resp.json();
             window.PhonePeCheckout.transact({
-                tokenUrl: payData.redirectUrl,
+                tokenUrl: data.redirectUrl,
                 type: "IFRAME",
-                callback: () => onSuccess(payData)
+                callback: () => onSuccess(data)
             });
         }
         catch (err) {