@opengis/pay 1.3.2 → 2.0.0

package/README.md

@@ -1,29 +1,62 @@
-# pay
+# OpenGIS Pay
 
 [![NPM version](https://img.shields.io/npm/v/@opengis/pay)](https://www.npmjs.com/package/@opengis/pay)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
 
-It standardizes the entire payment process
+Стандартизований NPM модуль для інтеграції різних платіжних систем з єдиним API.
 
-## Install
+## Особливості
+
+- **Підтримка різних платіжних систем**: Liqpay, Portmone, Monopay
+- **Проста інтеграція**: NPM пакет з мінімальними налаштуваннями
+- **Стандартизовані API**: Єдиний інтерфейс для роботи з різними платіжними системами
+- **Безпека**: Надіжна обробка платежів з підтримкою webhook'ів
+
+## Встановлення
 
 ```bash
 npm i @opengis/pay
 ```
 
-## Publish
+## Швидкий старт
 
-```bash
-npm run build
-npm publish
+```js
+fastify.register(import('@opengis/pay'), config);
 ```
 
-## Usage
-
 ```js
-app.register(import('@opengis/pay'), config);
+// config/env
+{
+    "integrations": {
+        "pay": {
+            "host": "https://www.portmone.com.ua", // Посилання на portmone
+            "payeeId": 1185, // Ідентифікатор інтернет-магазину
+            "paymentRedirect": "/payments-success?id={{id}}"
+        },
+        "monopay": {
+            "host": "https://api.monobank.ua",
+            "token": "",
+            "paymentRedirect": "/payments-success?id={{id}}"
+        },
+        "liqpay": {
+            "publicKey": "sandbox_i7577029572",
+            "privateKey": "sandbox_JPqUTRby6eI0fMyIM1zRabka9rhtmjjt2ddDmmZL",
+            "paymentRedirect": "/payments-success?id={{id}}"
+        }
+    }
+}
 ```
 
-## Documenation
+## Документація
+
+Для детального розуміння можливостей `@opengis/pay`, його функцій та способів використання, зверніться до нашої [Документації](https://apidocs.softpro.ua/pay).
+
+## Підтримувані платіжні системи
+
+- **Liqpay** - Українська платіжна система
+- **Portmone** - Міжнародна платіжна система
+- **Monopay** - API Monobank для прийому платежів
+
+## Ліцензія
 
-For a detailed understanding of `pay plugin` for billing, its features, and how to use them, refer to our [Documentation](https://apidocs.softpro.ua/opengis/plugin/pay.html).
+MIT

package/module/pay/pt/marketplace-service-payment-client-template.html

@@ -33,14 +33,14 @@
                                                     <br>
                                                     <span style="color:#61677b"><strong>Дата створення платежу:</strong> {{created_at}}</span>
                                                     <br>
-                                                    <span style="color:#61677b"><strong>Статус платежу:</strong> {{payment_status}}</span>
-                                                    {{#if payment_amount}}
+                                                    <span style="color:#61677b"><strong>Статус платежу:</strong> {{status}}</span>
+                                                    {{#if amount}}
                                                         <br>
-                                                        <span style="color:#61677b"><strong>Поповнення рахунку:</strong> {{payment_amount}}</span>
+                                                        <span style="color:#61677b"><strong>Поповнення рахунку:</strong> {{amount}}</span>
                                                     {{/if}}  
-                                                    {{#if total_balance}}
+                                                    {{#if balance}}
                                                         <br>
-                                                        <span style="color:#61677b"><strong>Поточний баланс:</strong> {{total_balance}}</span>
+                                                        <span style="color:#61677b"><strong>Поточний баланс:</strong> {{balance}}</span>
                                                     {{/if}}
                                                 </td>
                                                 <td style="padding:7px 0" width="10">&nbsp;</td>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengis/pay",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "type": "module",
   "description": "pay plugins for billing",
   "main": "plugin.js",
@@ -20,18 +20,20 @@
     "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore"
   },
   "dependencies": {
-    "ioredis": "5.3.2",
     "liqpayjs-sdk": "3.3.1",
-    "nodemailer": "6.5.0",
-    "pg": "8.11.3",
     "request-promise": "4.2.6"
   },
   "devDependencies": {
+    "dotenv": "^17.2.2",
+    "eslint": "8.49.0",
+    "eslint-config-airbnb": "19.0.4",
     "fastify": "5.3.3",
     "fastify-plugin": "5.0.1",
-    "eslint": "8.49.0",
-    "eslint-config-airbnb": "19.0.4"
+    "ioredis": "5.3.2",
+    "nodemailer": "6.5.0",
+    "pg": "8.11.3",
+    "vitest": "^3.2.4"
   },
   "author": "Softpro",
   "license": "ISC"
-}
+}

package/plugin.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-param-reassign */
 import fp from 'fastify-plugin';
 import path from 'node:path';
 import { fileURLToPath } from 'url';
@@ -22,6 +23,7 @@ async function plugin(app, config = {}) {
   app.register(import('./server/routes/portmone/index.mjs'), config);
   app.register(import('./server/routes/liqpay/index.mjs'), config);
   app.register(import('./server/routes/monopay/index.mjs'), config);
+  app.register(import('./server/routes/core/index.mjs'), config);
 
   execMigrations(path.join(dirname, 'server/migrations'), pg).catch(err => console.log(err));
 }

package/server/migrations/7_transactions.sql

@@ -0,0 +1,35 @@
+create schema if not exists pay;
+
+CREATE TABLE if not exists pay.transactions();
+alter table pay.transactions drop constraint if exists pay_transactions_transaction_id_pkey cascade;
+
+alter table pay.transactions add column if not exists transaction_id text NOT NULL default next_id();
+alter table pay.transactions add column if not exists user_id text;
+alter table pay.transactions add column if not exists status text NOT NULL DEFAULT 'inprogress'::text;
+alter table pay.transactions add column if not exists success_date timestamp with time zone;
+alter table pay.transactions add column if not exists data json;
+alter table pay.transactions add column if not exists amount numeric;
+alter table pay.transactions add column if not exists service text;
+alter table pay.transactions add column if not exists balance numeric;
+alter table pay.transactions add column if not exists referer_url text;
+alter table pay.transactions add column if not exists created_at timestamp without time zone DEFAULT now();
+alter table pay.transactions add column if not exists created_by text NOT NULL default '0';
+alter table pay.transactions add column if not exists updated_by text;
+alter table pay.transactions add column if not exists updated_at timestamp without time zone;
+alter table pay.transactions add column if not exists invoice_id text;
+
+COMMENT ON TABLE pay.transactions IS 'Платежі';
+COMMENT ON COLUMN pay.transactions.transaction_id IS 'ID';
+COMMENT ON COLUMN pay.transactions.user_id IS 'ID користувача';
+COMMENT ON COLUMN pay.transactions.status IS 'Статус транзації';
+COMMENT ON COLUMN pay.transactions.success_date IS 'Дата успішного завершення транзакції';
+COMMENT ON COLUMN pay.transactions.data IS 'Дані від сервісу оплати';
+COMMENT ON COLUMN pay.transactions.service IS 'Сервіс оплати (portmone, liqpay)';
+COMMENT ON COLUMN pay.transactions.amount IS 'Сума поповнення рахунку';
+COMMENT ON COLUMN pay.transactions.balance IS 'Поточний баланс';
+COMMENT ON COLUMN pay.transactions.referer_url IS 'Посилання';
+COMMENT ON COLUMN pay.transactions.invoice_id IS 'ID транзакції з сервісу оплати';
+
+CREATE INDEX if not exists pay_transactions_transactions_status_btree_idx ON pay.transactions USING btree (status COLLATE pg_catalog."default");
+
+alter table pay.transactions add CONSTRAINT pay_transactions_transaction_id_pkey PRIMARY KEY (transaction_id);

package/server/plugins/hook.js

@@ -1,24 +1,41 @@
 // import addCron from '../utils/cron/addCron.js';
+import config from '../../config.js';
 import pgClients from './pg/pgClients.js';
 
-import updateTrxStatus from '../routes/portmone/utils/portmone.check.status.js';
+import updatePortmoneTrxStatus from './payment/portmone.checkStatus.js';
+import updateLiqPayTrxStatus from './payment/liqpay.checkStatus.js';
+import updateMonoPayTrxStatus from './payment/monopay.checkStatus.js';
 
-// to do: for liqpay and monopay
-async function updateOldTrxsStatus() {
-  const inprogress = pgClients.client.pk?.['billing.payments']
-    ? await pgClients.client.query(`select array_agg(payment_id) as inprogress from billing.payments 
-        where payment_service='portmone' and payment_status = 'inprogress' and (now() - cdate) > '1 hour'::interval`).then(el => el.rows?.[0]?.inprogress || [])
+const { table = 'pay.transactions' } = config.integrations?.pay || {};
+
+async function updateOldTrxsStatus(service) {
+  const inprogress = pgClients.client.pk?.[table]
+    ? await pgClients.client.query(`select ${pgClients.client.pk?.[table]} as id, service from ${table} 
+        where service=$1 and status = 'inprogress' and (now() - created_at) > '1 hour'::interval`, [service]).then(el => el.rows || [])
     : [];
 
   if (!inprogress?.length) return 'empty rows';
 
-  const res = await Promise.all(inprogress.map(async (paymentId) => {
-    const data = await updateTrxStatus({ paymentId });
-    return { paymentId, data };
+  return; // !refactor required
+  const res = await Promise.all(inprogress.map(async ({ id, service }) => {
+    if (service === 'portmone') {
+      const data = await updatePortmoneTrxStatus(id);
+      return { paymentId: id, data };
+    }
+    if (service === 'liqpay') {
+      const data = await updateLiqPayTrxStatus(id);
+      return { paymentId: id, data };
+    }
+    if (service === 'monopay') {
+      const data = await updateMonoPayTrxStatus(id);
+      return { paymentId: id, data };
+    }
+    return null;
   }));
   return res;
 }
 
 export default async function cron() {
-  //   addCron(updateOldTrxsStatus, 60 * 60 * 24);
+  // !disabled
+  // addCron(updateOldTrxsStatus, 60 * 60 * 24);
 }

package/server/plugins/payment/createPayment.js

@@ -0,0 +1,29 @@
+import config from '../../../config.js';
+import pgClients from '../pg/pgClients.js';
+import dataInsert from '../crud/dataInsert.js';
+
+const { paymentRedirect, table = 'pay.transactions' } = config.integrations?.pay || {};
+
+export default async function createPayment({
+    paymentId, price, referer, uid, service,
+}, pg = pgClients.client) {
+    if (!paymentId) { throw new Error('not enough params: paymentId'); }
+    if (!uid) { throw new Error('not enough params: uid'); }
+    if (!service) { throw new Error('not enough params: service'); }
+    if (!price) { throw new Error('not enough params: price'); }
+
+    const result = await dataInsert({
+        id: paymentId,
+        pg,
+        table,
+        data: {
+            referer_url: paymentRedirect ? paymentRedirect.replace(/{{id}}/g, paymentId) : referer,
+            amount: price,
+            user_id: uid,
+            service,
+            status: 'inprogress',
+        },
+        uid,
+    }).then(el => el.rows?.[0]);
+    return { id: paymentId, ...result || {} };
+}

package/server/plugins/payment/createTransaction.js

@@ -0,0 +1,26 @@
+import pgClients from '../pg/pgClients.js';
+
+import liqpayCreateTransaction from './liqpay.createTransaction.js';
+
+import portmoneCreateTransaction from './portmone.createTransaction.js';
+
+import monopayCreateTransaction from './monopay.createTransaction.js';
+
+const controller = {
+    liqpay: liqpayCreateTransaction,
+    monopay: monopayCreateTransaction,
+    portmone: portmoneCreateTransaction,
+};
+
+export default async function createTransaction({
+    id, price, rootUrl, referer, uid, debug, service,
+}, pg = pgClients.client) {
+    if (!service) throw new Error('not enough params: service');
+    if (!controller[service]) { throw new Error('invalid params: service'); }
+    if (price && !uid) throw new Error('not enough params: uid');
+
+    const result = await controller[service]({
+        id, price, rootUrl, referer, uid, debug,
+    }, pg);
+    return result;
+}

package/server/plugins/payment/liqpay.checkStatus.js

@@ -0,0 +1,43 @@
+import LiqPay from 'liqpayjs-sdk';
+import request from 'request-promise';
+
+import config from '../../../config.js';
+import pgClients from '../pg/pgClients.js';
+
+const { table = 'pay.transactions' } = config.integrations?.pay || {};
+const { host = 'https://www.liqpay.ua', publicKey, privateKey } = config.integrations?.liqpay || {};
+
+const liqpay = new LiqPay(publicKey, privateKey);
+
+export default async function liqpayCheckStatus(id, origin, pg = pgClients.client) {
+    if (!id) throw new Error('not enough params: id');
+    if (!publicKey || !privateKey) throw new Error('empty integration params: liqpay');
+
+    const options = {
+        public_key: publicKey, // in case of liqpay.api is auto-assigned
+        action: 'status',
+        version: '3',
+        order_id: id,
+    };
+    /* const result = liqpay.api('request', options); */
+
+    const data = Buffer.from(JSON.stringify(options)).toString('base64');
+    const signature = liqpay.str_to_sign(privateKey + data + privateKey);
+
+    const isValidOrigin = origin && origin === host;
+
+    if (process.env.NODE_ENV === 'test' && isValidOrigin) {
+        const amount = pg?.pk?.[table] ? await pg.query(`select amount from ${table} where ${pg?.pk?.[table]}=$1`, [id]).then(el => el.rows?.[0]?.amount) : 0;
+        return { unittest: true, amount, status: 'success' };
+    }
+
+    const response = await request(`${host}/api/request`, {
+        method: 'POST',
+        form: { data, signature },
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+        },
+    });
+    const result = response?.startsWith?.('{') ? JSON.parse(response) : response;
+    return result;
+}

package/server/plugins/payment/liqpay.createTransaction.js

@@ -0,0 +1,103 @@
+import request from 'request-promise';
+import LiqPay from 'liqpayjs-sdk';
+
+import config from '../../../config.js';
+import pgClients from '../pg/pgClients.js';
+
+import createPayment from './createPayment.js';
+
+const { prefix = '/api' } = config;
+const { table = 'pay.transactions' } = config.integrations?.pay || {};
+
+const {
+    host = 'https://www.liqpay.ua',
+    publicKey,
+    privateKey,
+} = config.integrations?.liqpay || {};
+const liqpay = new LiqPay(publicKey, privateKey);
+
+export default async function liqpayCreateTransaction({
+    id, price, rootUrl, referer, uid, debug,
+}, pg = pgClients.client) {
+    if (!publicKey || !privateKey) {
+        throw new Error('invalid liqpay integration settings');
+    }
+
+    if (!id && !price) {
+        throw new Error('not enough params: id or price required');
+    }
+
+    if (!rootUrl) {
+        throw new Error('not enough params: rootUrl required');
+    }
+
+    if (!uid) {
+        throw new Error('not enough params: uid required');
+    }
+
+    const paymentId = !id ? await pg.query('select next_id()').then(el => el.rows?.[0]?.next_id) : id;
+
+    const paymentData = id && pg.pk?.[table]
+        ? await pg.query(`select ${pg.pk?.[table]} as id, * from ${table} where ${pg.pk?.[table]}=$1`, [id]).then(el => el.rows?.[0])
+        : await createPayment({
+            paymentId,
+            price,
+            referer,
+            uid,
+            service: 'liqpay',
+        });
+
+    if (!paymentData?.id) {
+        throw new Error('payment not found / creation failed');
+    }
+
+    const paymentAmount = id ? paymentData.amount : price;
+
+    if (!paymentAmount) {
+        throw new Error('invalid payment amount');
+    }
+
+    const paymentOptions = {
+        action: 'pay',
+        amount: paymentAmount,
+        currency: 'UAH',
+        description: 'regular payment',
+        order_id: paymentData.id,
+        version: '3',
+        // server_url: `${rootUrl}${prefix}/liqpay/${paymentData.id}/success`, // update payment info - api url, does not work on sdk package out of the box
+        result_url: `${rootUrl}${prefix}/liqpay/${paymentData.id}/success`, // redirect user after payment - page url
+    };
+
+    // html interface for debug via browser only
+    if (process.env.NODE_ENV !== 'test' && debug) {
+        return liqpay.cnb_form(paymentOptions);
+    }
+
+    const { data, signature } = liqpay.cnb_object(paymentOptions) || {};
+
+    const response = await request({
+        url: `${host}/api/3/checkout`,
+        method: 'POST',
+        form: { data, signature },
+        followAllRedirects: false,
+        jar: true,
+        timeout: 6000,
+        simple: false, // prevent not 2xx code trigger catch
+        resolveWithFullResponse: true,
+    });
+
+    if (response.statusCode !== 302 || !response.headers?.location) {
+        throw new Error(response);
+    }
+
+    if (response.headers?.location?.includes?.('throw_error')) {
+        throw new Error(response.headers?.location);
+    }
+
+    // debug via unt test
+    if (process.env.NODE_ENV === 'test' && debug) {
+        return { url: response.headers.location, id: paymentData.id };
+    }
+
+    return response.headers.location;
+}

package/server/plugins/payment/monopay.checkStatus.js

@@ -0,0 +1,48 @@
+import config from '../../../config.js';
+import pgClients from '../pg/pgClients.js';
+
+const { table = 'pay.transactions' } = config.integrations?.pay || {};
+
+const {
+    host = 'https://api.monobank.ua',
+    token,
+} = config.integrations?.monopay || {};
+
+const timeoutMs = 5000;
+
+export default async function monopayCheckStatus(id, origin, pg = pgClients.client) {
+    if (!id) { throw new Error('not enough params: id'); }
+
+    const {
+        paymentId, invoice_id: invoiceId, amount,
+    } = await pg.query(`select ${pg.pk?.[table]} as "paymentId", * from ${table} where ${pg.pk?.[table]}=$1`, [id])
+        .then(el => el.rows?.[0] || {});
+
+    if (!paymentId) {
+        throw new Error('payment not found');
+    }
+
+    const isValidOrigin = origin && origin === host;
+
+    if (process.env.NODE_ENV === 'test' && isValidOrigin) {
+        return { unittest: true, amount, status: 'success' };
+    }
+
+    if (!invoiceId) {
+        throw new Error('invoice not found');
+    }
+
+    const resp = await fetch(`${host}/api/merchant/invoice/status?invoiceId=${invoiceId}`, {
+        method: 'GET',
+        headers: { 'x-token': token },
+        signal: AbortSignal.timeout(timeoutMs),
+    });
+
+    const contentType = resp.headers.get('Content-Type');
+
+    const body = contentType.includes('application/json') && resp.status === 200
+        ? await resp.json()
+        : { error: await resp.text() };
+
+    return { ...body, amount: body.amount / 100, status: body.status };
+}

package/server/plugins/payment/monopay.createTransaction.js

@@ -0,0 +1,116 @@
+import config from '../../../config.js';
+import pgClients from '../pg/pgClients.js';
+import dataUpdate from '../crud/dataUpdate.js';
+
+import createPayment from './createPayment.js';
+
+const { prefix = '/api' } = config;
+const { table = 'pay.transactions' } = config.integrations?.pay || {};
+
+const {
+    host = 'https://api.monobank.ua',
+    token,
+    merchantPaymInfo,
+} = config.integrations?.monopay || {};
+
+const timeoutMs = 5000;
+
+export default async function monopayCreateTransaction({
+    id, price, rootUrl, referer, uid, debug,
+}, pg = pgClients.client) {
+    if (!host) {
+        throw new Error('empty integration host');
+    }
+
+    if (!token) {
+        throw new Error('empty integration token');
+    }
+
+    if (!id && !price) {
+        throw new Error('not enough params: id or price required');
+    }
+
+    if (!rootUrl) {
+        throw new Error('not enough params: rootUrl required');
+    }
+
+    if (!uid) {
+        throw new Error('not enough params: uid required');
+    }
+
+    const paymentId = !id ? await pg.query('select next_id()').then(el => el.rows?.[0]?.next_id) : id;
+
+    const paymentData = id && pg.pk?.[table]
+        ? await pg.query(`select ${pg.pk?.[table]} as id, * from ${table} where ${pg.pk?.[table]}=$1`, [id]).then(el => el.rows?.[0])
+        : await createPayment({
+            paymentId,
+            price,
+            referer,
+            uid,
+            service: 'monopay',
+        });
+
+    if (!paymentData?.id) {
+        throw new Error('payment not found / creation failed');
+    }
+    const paymentAmount = id ? paymentData.amount : price;
+
+    if (!paymentAmount) {
+        throw new Error('invalid payment amount');
+    }
+
+    // redirect to api to check payment status and redirect user to page afterwards
+    const serverUrl = `${rootUrl}${prefix}/monopay/${paymentId}/success`;
+
+    const paymentOptions = {
+        amount: paymentAmount * 100, // price=1 === 0.01 uah
+        ccy: 980, // ISO 4217, 980 = UAH
+        merchantPaymInfo,
+        redirectUrl: serverUrl,
+        // redirectUrl: (paymentRedirect ? `${rootPageUrl}${paymentRedirect.replace(/{{id}}/g, paymentId)}` : headers?.referer) || rootPageUrl,
+        webHookUrl: serverUrl,
+        validity: 86400, // 1 day by default, then invalid
+        paymentType: 'debit',
+        // displayType: 'iframe', // default = null > url to mono
+    };
+
+    const resp = await fetch(`${host}/api/merchant/invoice/create`, {
+        method: 'POST',
+        headers: { 'x-token': token },
+        body: JSON.stringify(paymentOptions),
+        signal: AbortSignal.timeout(timeoutMs),
+    });
+
+    const contentType = resp.headers.get('Content-Type');
+
+    const response = contentType.includes('application/json') && resp.status === 200
+        ? await resp.json()
+        : await resp.text();
+
+    // !save invoice ID to check status later
+    await dataUpdate({
+        table,
+        id: paymentId,
+        data: {
+            invoice_id: response?.invoiceId,
+            data: resp.status === 200 ? undefined : { response },
+            status: resp.status === 200 ? 'inprogress' : 'error',
+        },
+        uid,
+    });
+
+    if (process.env.NODE_ENV !== 'test' && debug) {
+        return response;
+    }
+
+    // handle exceptions
+    if (!response?.pageUrl) {
+        throw new Error(response);
+    }
+
+    if (process.env.NODE_ENV === 'test' && debug) {
+        return { id: paymentId, url: response.pageUrl };
+    }
+
+    return response.pageUrl;
+}

package/server/plugins/payment/paymentInfo.js

@@ -0,0 +1,26 @@
+import config from '../../../config.js';
+import pgClients from '../pg/pgClients.js';
+
+const { table = 'pay.transactions' } = config.integrations?.pay || {};
+
+export default async function paymentInfo(id, pg = pgClients.client) {
+    if (!id) throw new Error('not enough params: id');
+
+    const {
+        amount,
+        status,
+        service,
+        referer_url: referer,
+        user_id: userId,
+    } = id && pg.pk?.[table] ? await pg.query(`select ${pg.pk?.[table]} as id, * from ${table} where ${pg.pk?.[table]}=$1`, [id])
+        .then(el => el.rows?.[0] || {}) : {};
+
+    return {
+        id, // id for existing transtaction
+        price: amount, // price for new transtaction as is, else - preCreated
+        status, // payment status
+        service, // service name
+        referer, // redirect user after finish of transaction
+        uid: userId,
+    };
+}