elpaypg 0.0.0-stage → 2.0.0

package/.env.example

@@ -0,0 +1,8 @@
+# ELPAY PG environment variables
+DATABASE_URL=postgresql://user:password@localhost:5432/myapp
+BASE_URL=http://localhost:5000
+ELPAY_WEBHOOK_SECRET=change-me-to-a-long-random-string
+ELPAY_ADMIN_TOKEN=change-me-admin-token
+ELPAY_PUBLIC_KEY=pk_test_abc
+ELPAY_BIND_HOST=127.0.0.1
+```

package/README.md

@@ -1,3 +1,177 @@
-# Temporary Holding Version
+# elpay-pg — Simple Guide
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A payment gateway you install into your own backend. No separate servers. No extra ports. Your database stores everything.
+
+---
+
+## Environment setup (.env)
+
+Create a `.env` file in your project root:
+
+```env
+DATABASE_URL=postgresql://user:password@localhost:5432/myapp
+BASE_URL=http://localhost:5000
+ELPAY_WEBHOOK_SECRET=change-me-to-a-long-random-string
+ELPAY_ADMIN_TOKEN=change-me-admin-token
+ELPAY_PUBLIC_KEY=pk_test_abc
+```
+
+A template is included as `.env.example` in the package.
+
+---
+
+```bash
+npm install elpay-pg pg
+```
+
+## 2. Set environment variables
+
+Create a `.env` file:
+
+```
+DATABASE_URL=postgresql://user:password@localhost:5432/myapp
+BASE_URL=http://localhost:5000
+ELPAY_WEBHOOK_SECRET=any-long-random-string
+ELPAY_ADMIN_TOKEN=any-admin-token
+ELPAY_PUBLIC_KEY=pk_test_abc
+```
+
+## 3. Add to your backend (Express)
+
+```js
+import express from 'express';
+import { elpay } from 'elpay-pg';
+
+const app = express();
+app.use(express.json());
+
+const gateway = await elpay({
+  databaseUrl: process.env.DATABASE_URL,
+  baseUrl: process.env.BASE_URL,
+  webhookSecret: process.env.ELPAY_WEBHOOK_SECRET,
+  adminToken: process.env.ELPAY_ADMIN_TOKEN,
+  publicKey: process.env.ELPAY_PUBLIC_KEY,
+});
+
+// Mount everything under /elpay
+app.use('/elpay', gateway.router);
+
+// When a payment succeeds, update your orders
+gateway.on('payment:success', async ({ orderId, utr }) => {
+  await db.query('UPDATE orders SET status=$1, utr=$2 WHERE id=$3', ['paid', utr, orderId]);
+});
+
+app.listen(5000);
+```
+
+## 4. Add to your frontend (React)
+
+```jsx
+import { useEffect } from 'react';
+
+const SDK_URL = 'http://localhost:5000/elpay/elpay.js';
+
+export default function BuyButton() {
+  useEffect(() => {
+    if (document.getElementById('elpay-sdk')) return;
+    const s = document.createElement('script');
+    s.id = 'elpay-sdk';
+    s.src = SDK_URL;
+    s.setAttribute('data-elpay-key', 'pk_test_abc');
+    document.body.appendChild(s);
+  }, []);
+
+  const buy = () => {
+    window.Elpay?.pay({
+      order_id: 'ORDER-1',
+      amount: 499,
+      currency: 'INR',
+      customer: { name: 'Mohit', email: 'mohit@example.com' },
+      handler: (res) => console.log('Paid', res),
+      onClose: () => console.log('Closed')
+    });
+  };
+
+  return <button onClick={buy}>Buy Now</button>;
+}
+```
+
+## 5. Run
+
+- Start Postgres
+- Start your backend on port 5000
+- Start your frontend (Vite/React)
+- Click "Buy Now" → modal opens → pay with UPI
+
+## 6. Admin dashboard
+
+Open `http://localhost:5000/elpay/admin` and log in with `ELPAY_ADMIN_TOKEN`.
+
+---
+
+## If auto-migration fails
+
+The module runs migrations automatically on first boot. If that fails (permissions, network, etc.), run this SQL manually in your Postgres database:
+
+```sql
+-- Minimal tables required by elpay-pg
+CREATE TABLE IF NOT EXISTS merchants (
+  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  name TEXT NOT NULL,
+  webhook_secret TEXT,
+  created_at TIMESTAMPTZ DEFAULT now()
+);
+
+CREATE TABLE IF NOT EXISTS payment_sessions (
+  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  merchant_id UUID REFERENCES merchants(id),
+  order_id TEXT NOT NULL,
+  amount_paise BIGINT NOT NULL,
+  currency TEXT DEFAULT 'INR',
+  status TEXT NOT NULL,
+  method TEXT DEFAULT 'UPI',
+  utr TEXT,
+  created_at TIMESTAMPTZ DEFAULT now(),
+  expires_at TIMESTAMPTZ,
+  completed_at TIMESTAMPTZ
+);
+
+CREATE TABLE IF NOT EXISTS elpay_migrations (
+  id SERIAL PRIMARY KEY,
+  name TEXT NOT NULL,
+  applied_at TIMESTAMPTZ DEFAULT now()
+);
+```
+
+Then restart your backend — it will detect the tables and skip re-creating them.
+
+---
+
+## Theming
+
+Pass a `theme` object:
+
+```js
+const gateway = await elpay({
+  // ...
+  theme: {
+    primaryColor: '#ff5722',
+    borderRadius: '12px',
+    fontFamily: 'Inter, sans-serif'
+  }
+});
+```
+
+Or override CSS variables in your own stylesheet:
+
+```css
+:root {
+  --elpay-primary: #ff5722;
+  --elpay-radius: 12px;
+  --elpay-font: Inter, sans-serif;
+}
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,23 @@
 {
   "name": "elpaypg",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2.0.0",
+  "description": "ELPAY PG - single-backend payment gateway module",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": [
+    "src/",
+    "public/",
+    "README.md",
+    ".env.example"
+  ],
+  "dependencies": {
+    "express": "^4.19.0",
+    "qrcode": "^1.5.4"
+  },
+  "engines": {
+    "node": ">=22.5.0"
+  }
+}