node-paytmpg 7.1.3 → 7.1.6

package/dist/app/controllers/adapters/open_money.d.ts

@@ -0,0 +1,23 @@
+export interface OpenMoneyConfig {
+    accesskey: string;
+    secretkey: string;
+    url: string;
+    script_url: string;
+    KEY?: string;
+    SECRET?: string;
+    open_money_url?: string;
+}
+type AnyObject = {
+    [k: string]: any;
+};
+export default class OpenMoney {
+    config: OpenMoneyConfig;
+    constructor(npconfig: AnyObject);
+    generatePaymentToken(params: AnyObject): Promise<AnyObject>;
+    verifyResult(req: AnyObject): Promise<AnyObject>;
+    processWebhook(req: AnyObject, res: AnyObject, updateTransaction: Function): void;
+    getPaymentStatus(paymentTokenId: string, cb?: (data: any) => void): Promise<any>;
+    renderProcessingPage(params: AnyObject, pmttoken: AnyObject, res: AnyObject, loadingSVG: string): void;
+    renderError(params: AnyObject, error: any, res: AnyObject): void;
+}
+export {};

package/dist/app/controllers/adapters/paytm.d.ts

@@ -0,0 +1,2 @@
+import { NPConfig, NPParam } from "../../models";
+export declare function createPaytmJsCheckoutHtml(params: NPParam, config: NPConfig): string;

package/dist/app/controllers/adapters/payu.d.ts

@@ -0,0 +1,41 @@
+type Dict = Record<string, any>;
+interface PayUConfig {
+    key: string;
+    salt: string;
+    baseUrl: string;
+    paymentUrl: string;
+    verifyUrl: string;
+}
+interface PayURequestLike {
+    body?: Dict;
+    query?: Dict;
+    rawBody?: any;
+    headers?: Dict;
+}
+interface PayUResponseLike {
+    writeHead: (status: number, headers: Dict) => void;
+    write: (chunk: string) => void;
+    end: () => void;
+    status: (code: number) => void;
+    send: (body: any) => void;
+}
+declare class PayU {
+    config: PayUConfig;
+    constructor(npconfig: Dict);
+    normalizeAmount(amount: any): string;
+    buildRequestHash(payload: Dict): string;
+    buildResponseHash(data: Dict): string;
+    generatePaymentRequest(params: Dict): {
+        html: string;
+        payload: Dict;
+    };
+    decodeTransactionResponse(txnDataBase64FromPayu: string): Dict;
+    verifyResult(req: PayURequestLike): Promise<Dict>;
+    getPaymentStatus(txnId: string): Promise<Dict>;
+    postCommand(command: string, transactionId: string): Promise<Dict>;
+    checkBqrTxnStatus(transactionId: string): Promise<Dict>;
+    renderProcessingPage(params: Dict, paymentReq: Dict, res: PayUResponseLike, loadingSVG: string): void;
+    renderError(params: Dict, error: any, res: PayUResponseLike): void;
+    processWebhook(req: PayURequestLike, res: PayUResponseLike, updateTransaction: Function): void;
+}
+export default PayU;

package/dist/app/controllers/checksum/PaytmChecksum.d.ts

@@ -0,0 +1,13 @@
+export default class PaytmChecksum {
+    static iv: string;
+    static encrypt(input: string, key: string): string;
+    static decrypt(encrypted: string, key: string): string;
+    static generateSignature(params: Record<string, any> | string, key: string): Promise<string> | Promise<never>;
+    static verifySignature(params: Record<string, any> | string, key: string, checksum: string): boolean | Promise<never>;
+    static generateSignatureByString(params: string, key: string): Promise<string>;
+    static verifySignatureByString(params: string, key: string, checksum: string): boolean;
+    static generateRandomString(length: number): Promise<string>;
+    static getStringByParams(params: Record<string, any>): string;
+    static calculateHash(params: string, salt: string): string;
+    static calculateChecksum(params: string, key: string, salt: string): string;
+}

package/dist/app/controllers/checksum/checksum.d.ts

@@ -0,0 +1,15 @@
+export declare function genchecksum(params: Record<string, any>, key: string, cb: (err: any, checksum?: string) => void): Promise<void>;
+export declare function genchecksumbystring(params: string, key: string, cb: (err: any, checksum?: string) => void): void;
+export declare function verifychecksum(params: Record<string, any>, key: string, checksumhash?: string): boolean | Promise<never>;
+export declare function verifychecksumbystring(params: string, key: string, checksumhash: string): boolean;
+export declare function genchecksumforrefund(params: Record<string, any>, key: string, cb: (err: any, result?: any) => void): void;
+export declare function checkRazorSignature(razorpayOrderId: string, razorpayPaymentId: string, secret: string, razorpay_signature: string): boolean;
+declare const _default: {
+    genchecksum: typeof genchecksum;
+    verifychecksum: typeof verifychecksum;
+    verifychecksumbystring: typeof verifychecksumbystring;
+    genchecksumbystring: typeof genchecksumbystring;
+    genchecksumforrefund: typeof genchecksumforrefund;
+    checkRazorSignature: typeof checkRazorSignature;
+};
+export default _default;

package/dist/app/controllers/checksum/crypt.d.ts

@@ -0,0 +1,15 @@
+export declare const iv = "@@@@&&&&####$$$$";
+export declare function encrypt(data: string, custom_key: string): string;
+export declare function decrypt(data: string, custom_key: string): string;
+export declare function gen_salt(length: number): Promise<string>;
+export declare function md5sum(salt: string, data: string): string;
+export declare function sha256sum(salt: string, data: string): string;
+declare const _default: {
+    iv: string;
+    encrypt: typeof encrypt;
+    decrypt: typeof decrypt;
+    gen_salt: typeof gen_salt;
+    md5sum: typeof md5sum;
+    sha256sum: typeof sha256sum;
+};
+export default _default;

package/dist/app/controllers/checksum/server.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/app/controllers/htmlhelper.d.ts

@@ -0,0 +1,9 @@
+import { Request, Response } from 'express';
+import { NPConfig } from '../models';
+export declare function renderView(req: Request, res: Response, viewFile: string, data: any): void | Response<any, Record<string, any>>;
+export declare function buildAutoPostFormHtml(action: string, fields: Record<string, any>, title?: string): string;
+export declare function sendAutoPostForm(req: Request, res: Response, action: string, fields: Record<string, any>): Response<any, Record<string, any>>;
+export declare function buildProcessingPageHtml(innerHtml: string, loadingSVG?: string, title?: string, headScripts?: string, bodyScripts?: string): string;
+export declare function renderProcessingPage(req: Request, res: Response, innerHtml: string, loadingSVG?: string, headScripts?: string, bodyScripts?: string): Response<any, Record<string, any>>;
+export declare function renderPaytmJsCheckout(req: Request, res: Response, paytmJsToken: any, config: NPConfig): Response<any, Record<string, any>>;
+export declare function renderRazorpayCheckout(req: Request, res: Response, params: Record<string, any>, config: NPConfig, loadingSVG: string): Response<any, Record<string, any>>;

package/dist/app/controllers/payment.controller.d.ts

@@ -0,0 +1,30 @@
+import { MultiDbORM } from 'multi-db-orm';
+import { Request, Response } from 'express';
+import { NPConfig, NPTableNames } from '../models';
+export declare class PaymentController {
+    private config;
+    private callbacks;
+    private db;
+    private tableNames;
+    private useController;
+    private viewPath;
+    private payuInstance;
+    private openMoneyInstance;
+    private razorPayInstance;
+    constructor(config: NPConfig, db: MultiDbORM, callbacks?: any, tableNames?: NPTableNames);
+    encodeTxnDataForUrl(txnDataJson: any): string;
+    decodeTxnDataFromUrl(encodedStr: string): any;
+    private configure;
+    private insertTransactionInDb;
+    private generateChecksum;
+    home(req: Request, res: Response): void | Response<any, Record<string, any>>;
+    init(req: Request, res: Response): Promise<void | Response<any, Record<string, any>>>;
+    updateTransaction(req: Request, res: Response): Promise<void>;
+    callback(req: Request, res: Response): Promise<void>;
+    webhook(req: Request, res: Response): Promise<void>;
+    createTxn(req: Request, res: Response): Promise<void>;
+    createTxnToken(req: Request, res: Response): Promise<void>;
+    getTransactions(req: Request, res: Response): Promise<void>;
+    status(req: Request, res: Response): Promise<void>;
+    private getStatusFromPaytm;
+}

package/dist/app/controllers/static/loadingsvg.d.ts

@@ -0,0 +1 @@
+export declare const LoadingSVG = " <svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" style=\"margin:auto;background:#fff;display:block;\" width=\"200px\" height=\"200px\" viewBox=\"0 0 100 100\" preserveAspectRatio=\"xMidYMid\">\n<g transform=\"rotate(0 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.9166666666666666s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(30 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.8333333333333334s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(60 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.75s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(90 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.6666666666666666s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(120 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.5833333333333334s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(150 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.5s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(180 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.4166666666666667s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(210 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.3333333333333333s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(240 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.25s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(270 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.16666666666666666s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(300 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"-0.08333333333333333s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g><g transform=\"rotate(330 50 50)\">\n<rect x=\"47\" y=\"24\" rx=\"3\" ry=\"6\" width=\"6\" height=\"12\" fill=\"#0097a7\">\n    <animate attributeName=\"opacity\" values=\"1;0\" keyTimes=\"0;1\" dur=\"1s\" begin=\"0s\" repeatCount=\"indefinite\"></animate>\n</rect>\n</g>\n</svg>";

package/dist/app/controllers/user.controller.d.ts

@@ -0,0 +1,9 @@
+import { MultiDbORM } from "multi-db-orm";
+import { NPUser } from "../models";
+export declare class NPUserController {
+    db: MultiDbORM;
+    tableName: string;
+    constructor(db: MultiDbORM, tableName?: string);
+    init(): Promise<void>;
+    create(userData: NPUser): Promise<NPUser>;
+}

package/dist/app/models/index.d.ts

@@ -0,0 +1,78 @@
+export type Callback = (err?: any, res?: any) => void;
+export interface NPUser {
+    id: string;
+    name: string;
+    email: string;
+    phone: string;
+    createdAt?: number;
+}
+/**
+ * NPTransaction is the interface for the transaction object stored in the database. It contains all the details of a transaction, including the order ID, customer ID, time of transaction, status, name, email, phone number, amount, product name, and any extra information.
+ * time: in miliseconds
+ * status: can be 'TXN_SUCCESS', 'TXN_FAILURE', 'PENDING', 'INITIATED'
+ * extra: json can be used to store any extra information related to the transaction, such as the payment method used, the bank name, etc.
+ */
+export interface NPTransaction {
+    id: string;
+    orderId: string;
+    cusId: string;
+    time: Number;
+    status: string;
+    name: string;
+    email: string;
+    phone: string;
+    amount: Number;
+    pname: string;
+    extra: string;
+    readonly?: string;
+    txnId?: string;
+    clientId: string;
+    returnUrl: string;
+    webhookUrl: string;
+}
+export interface NPCallbacks {
+    onStart: (orderId: string, paymentData?: NPTransaction) => void;
+    onFinish: (orderId: string, paymentData?: NPTransaction) => void;
+}
+export type NPConfig = {
+    KEY: string;
+    SECRET: string;
+    MID?: string;
+    WEBSITE?: string;
+    CHANNEL_ID?: string;
+    INDUSTRY_TYPE_ID?: string;
+    CALLBACK_URL?: string;
+    paytm_url?: string;
+    mode?: string;
+    razor_url?: string;
+    open_money_url?: string;
+    payu_url?: string;
+    templateDir?: string;
+    view_path: string;
+    theme_color?: string;
+    brand?: string;
+    logo?: string;
+    host_url?: string;
+    path_prefix: string;
+    id_length?: number;
+};
+export type NPTableNames = {
+    USER: string;
+    TRANSACTION: string;
+};
+export type NPParam = {
+    ORDER_ID?: string;
+    CUST_ID?: string;
+    TXN_AMOUNT: string;
+    CALLBACK_URL?: string;
+    EMAIL?: string;
+    MOBILE_NO?: string;
+    NAME?: string;
+    PRODUCT_NAME?: string;
+    RETURN_URL?: string;
+    MID?: string;
+    WEBSITE?: string;
+    CHANNEL_ID?: string;
+    INDUSTRY_TYPE_ID?: string;
+    CURRENCY?: string;
+};

package/dist/app/routes/payment_route.d.ts

@@ -0,0 +1,2 @@
+declare const paymentRoute: (app: any, express: any, callbacks?: any) => any;
+export default paymentRoute;

package/dist/app/utils/buildConfig.d.ts

@@ -0,0 +1,2 @@
+import { NPConfig } from "../models";
+export declare function buildConfig(userConfig?: Record<string, any>): NPConfig;

package/dist/app/utils/utils.d.ts

@@ -0,0 +1,5 @@
+import { NPTransaction } from "../models";
+export declare class Utils {
+    static makeid(length?: number): string;
+    static sanitizeRequest(body: NPTransaction | any): void;
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { Application, RequestHandler, Router } from 'express';
+import { NPCallbacks, NPConfig, NPTableNames } from './app/models';
+import { MultiDbORM } from 'multi-db-orm';
+export * from './app/models';
+export declare function attachViewEngine(app: Application, userConfig?: Partial<NPConfig>): void;
+export declare function createPaymentMiddleware(app: Application, userConfig: NPConfig, db: MultiDbORM, callbacks?: NPCallbacks, authenticationMiddleware?: RequestHandler, tableNames?: NPTableNames): Router;
+declare const _default: {
+    createPaymentMiddleware: typeof createPaymentMiddleware;
+};
+export default _default;

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachBodyParser = attachBodyParser;
+exports.attachViewEngine = attachViewEngine;
 exports.createPaymentMiddleware = createPaymentMiddleware;
 const express_1 = __importDefault(require("express"));
 const path_1 = __importDefault(require("path"));
@@ -26,7 +26,7 @@ const express_handlebars_1 = __importDefault(require("express-handlebars"));
 const payment_controller_1 = require("./app/controllers/payment.controller");
 const buildConfig_1 = require("./app/utils/buildConfig");
 __exportStar(require("./app/models"), exports);
-function attachBodyParser(app, userConfig = {}) {
+function attachViewEngine(app, userConfig = {}) {
     const config = (0, buildConfig_1.buildConfig)(userConfig);
     const saveRawBody = (req, res, buf) => {
         req.rawBody = buf && buf.toString();
@@ -51,9 +51,9 @@ function attachBodyParser(app, userConfig = {}) {
 }
 function createPaymentMiddleware(app, userConfig, db, callbacks, authenticationMiddleware, tableNames) {
     //check attachBodyParser
-    if (!app.get('attachBodyParser')) {
-        console.error('!!! Warning from node-paytmpg !!!: Body parser not attached by calling `attachBodyParser(app, config)`. Attaching default body parser. Please attach your own body parser if you have custom requirements. but make sure `rawBody` is attached to the request object for webhook verification.');
-        attachBodyParser(app, userConfig);
+    if (!app.get('view engine')) {
+        console.warn('[node-paytmpg]: View engine not attached. Attaching default view engine. Either call attachViewEngine() before createPaymentMiddleware() or ensure that your Express app has a view engine attached.');
+        attachViewEngine(app, userConfig);
     }
     const config = (0, buildConfig_1.buildConfig)(userConfig);
     const subApp = express_1.default.Router();

package/dist/package.json

@@ -1,8 +1,9 @@
 {
     "name": "node-paytmpg",
-    "version": "7.1.3",
+    "version": "7.1.6",
     "description": "Payment Gateway Integration using NodeJS",
     "main": "dist/index.js",
+    "types": "dist/index.d.ts",
     "scripts": {
         "start": "node example.js",
         "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "node-paytmpg",
-  "version": "7.1.3",
+  "version": "7.1.6",
   "description": "Payment Gateway Integration using NodeJS",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "start": "node example.js",
     "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",