upiqr 1.3.16 → 1.3.18

package/README.md

@@ -35,18 +35,18 @@ This package will work on client and server.
 
 ### Fields detail:
 
-| Fields            | Description                                       | Required  |
-|-------------------|---------------------------------------------------|-----------|
-| payeeVPA          | VPA address from UPI payment account              | Mandatory |
-| payeeName         | Merchant Name registered in UPI payment account   | Mandatory |
-| payeeMerchantCode | Merchant Code from UPI payment account            | Optional  |
-| transactionId     | Unique transaction id for merchant's reference    | Optional  |
-| transactionRef    | Unique transaction id for merchant's reference    | Optional  |
-| transactionNote   | Note will appear in payment app while transaction | Optional  |
-| amount            | Amount                                            | Optional  |
-| minimumAmount     | Minimum amount that has to be transferred         | Optional  |
-| currency          | Currency of amount (default: INR)                 | Optional  |
-| transactionRefUrl | URL for the order                                 | Optional  |
+| Fields             | Description                                       | Required  |
+|--------------------|---------------------------------------------------|-----------|
+| `payeeVPA`         | UPI ID of the payee (e.g., `example@upi`).        | Yes       |
+| `payeeName`        | Registered name of the payee (e.g., `John Doe`).  | Yes       |
+| `payeeMerchantCode`| Merchant Code from UPI payment account            | No        |
+| `transactionId`    | Unique transaction id for merchant's reference    | No        |
+| `transactionRef`   | Unique transaction id for merchant's reference    | No        |
+| `transactionNote`  | Note for the payment (e.g., `Electricity Bill`).  | No        |
+| `amount`           | Amount                                            | No        |
+| `minimumAmount`    | Amount to be paid (e.g., `100.00` or `499`).      | No        |
+| `currency`         | Currency of amount (default: `INR`)               | No        |
+| `transactionRefUrl`| URL for the order                                 | No        |
 
 
 In table, fields requirement column is based on static QR, For dynamic QR you need to change more fields along with `payeeVPA` and `payeeName`.

package/dist/index.d.ts

@@ -1,9 +1 @@
-import QRCode from 'qrcode';
-import { QRResult, UPIIntentParams } from './types/upiqr';
-/**
- * Generates a UPI QR code and intent URL.
- * @param {UPIIntentParams} params - The UPI intent parameters.
- * @param {QRCode.QRCodeToDataURLOptions} [qrOptions] - Optional QR code generation options.
- * @returns {Promise<QRResult>} - A promise that resolves to the QR code and intent URL.
- */
-export default function upiqr({ payeeVPA: pa, payeeName: pn, payeeMerchantCode: mc, transactionId: tid, transactionRef: tr, transactionNote: tn, amount: am, minimumAmount: mam, currency: cu, }: UPIIntentParams, qrOptions?: QRCode.QRCodeToDataURLOptions): Promise<QRResult>;
+import QRCode from'qrcode';import{QRResult,UPIIntentParams}from'./types/upiqr';export default function upiqr({payeeVPA:pa,payeeName:pn,payeeMerchantCode:mc,transactionId:tid,transactionRef:tr,transactionNote:tn,amount:am,minimumAmount:mam,currency:cu,}:UPIIntentParams,qrOptions?:QRCode.QRCodeToDataURLOptions):Promise<QRResult>;

package/dist/index.js

@@ -1,45 +1,8 @@
-import QRCode from 'qrcode';
-/**
- * Validates the required parameters for generating UPI intent.
- * @param {Object} params - The parameters object containing payeeVPA and payeeName.
- * @returns {string} - An error message if validation fails, otherwise an empty string.
- */
-function validate({ pa, pn }) {
-    if (!pa || !pn)
-        return "Virtual payee's address/name is compulsory";
-    if (pa.length < 5 || pn.length < 4)
-        return "Virtual payee's address/name is too short.";
-    return '';
-}
-/**
- * Builds the UPI intent URL from the given parameters.
- * @param {Object} params - The parameters object containing UPI intent fields.
- * @returns {string} - The constructed UPI intent URL.
- */
-function buildUrl(params) {
-    let qs = "";
-    for (let [key, value] of Object.entries(params)) {
-        if (value)
-            qs += `${encodeURIComponent(key)}=${encodeURIComponent(value)}&`;
-    }
-    return "upi://pay?" + qs.slice(0, -1); // Remove trailing '&'
-}
-/**
- * Generates a UPI QR code and intent URL.
- * @param {UPIIntentParams} params - The UPI intent parameters.
- * @param {QRCode.QRCodeToDataURLOptions} [qrOptions] - Optional QR code generation options.
- * @returns {Promise<QRResult>} - A promise that resolves to the QR code and intent URL.
- */
-export default function upiqr({ payeeVPA: pa, payeeName: pn, payeeMerchantCode: mc, transactionId: tid, transactionRef: tr, transactionNote: tn, amount: am, minimumAmount: mam, currency: cu, }, qrOptions) {
-    const params = { pa, pn, am, mam, cu, mc, tid, tr, tn };
-    const error = validate(params);
-    if (error)
-        return Promise.reject(new Error(error));
-    const intent = buildUrl(params);
-    return new Promise((resolve, reject) => {
-        QRCode
-            .toDataURL(intent, qrOptions)
-            .then((base64Data) => resolve({ qr: base64Data, intent }))
-            .catch(err => reject(new Error("Unable to generate UPI QR Code.\n" + err)));
-    });
-}
+import QRCode from'qrcode';function validate({pa,pn}){if(!pa||!pn)
+return"Virtual payee's address/name is compulsory";if(pa.length<5||pn.length<4)
+return"Virtual payee's address/name is too short.";return'';}
+function buildUrl(params){let qs="";for(let[key,value]of Object.entries(params)){if(value)
+qs+=`${encodeURIComponent(key)}=${encodeURIComponent(value)}&`;}
+return"upi://pay?"+qs.slice(0,-1);}
+export default function upiqr({payeeVPA:pa,payeeName:pn,payeeMerchantCode:mc,transactionId:tid,transactionRef:tr,transactionNote:tn,amount:am,minimumAmount:mam,currency:cu,},qrOptions){const params={pa,pn,am,mam,cu,mc,tid,tr,tn};const error=validate(params);if(error)
+return Promise.reject(new Error(error));const intent=buildUrl(params);return new Promise((resolve,reject)=>{QRCode.toDataURL(intent,qrOptions).then((base64Data)=>resolve({qr:base64Data,intent})).catch(err=>reject(new Error("Unable to generate UPI QR Code.\n"+err)));});}

package/dist/types/upiqr.d.ts

@@ -1,31 +1,3 @@
-/**
- * Supported image types for the QR code.
- */
-export type ImageType = 'png' | 'jpeg' | 'webp';
-/**
- * Base64 encoded image string.
- * @template imageType - The type of the image.
- */
-export type Base64<imageType extends ImageType> = `data:image/${imageType};base64,${string}`;
-/**
- * Parameters for generating UPI intent.
- */
-export interface UPIIntentParams {
-    payeeVPA: string;
-    payeeName: string;
-    payeeMerchantCode?: string;
-    transactionId?: string;
-    transactionRef?: string;
-    transactionNote?: string;
-    amount?: string;
-    minimumAmount?: string;
-    currency?: string;
-    transactionRefUrl?: string;
-}
-/**
- * Result of the UPI QR code generation.
- */
-export interface QRResult {
-    qr: Base64<ImageType>;
-    intent: string;
-}
+
+export type ImageType='png'|'jpeg'|'webp';export type Base64<imageType extends ImageType>=`data:image/${imageType};base64,${string}`;export interface UPIIntentParams{payeeVPA:string;payeeName:string;payeeMerchantCode?:string;transactionId?:string;transactionRef?:string;transactionNote?:string;amount?:string;minimumAmount?:string;currency?:string;transactionRefUrl?:string;}
+export interface QRResult{qr:Base64<ImageType>;intent:string;}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "upiqr",
-  "version": "1.3.16",
+  "version": "1.3.18",
   "description": "Generate NPCI's UPI QR code along with UPI intent link, By using it any payment is possible from UPI enabled apps.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
     "package.json"
   ],
   "scripts": {
-    "build": "tsc"
+    "minify": "jsmin -o dist/index.d.ts dist/index.d.ts && jsmin -o dist/index.js dist/index.js && jsmin -o dist/types/upiqr.d.ts dist/types/upiqr.d.ts",
+    "build": "tsc && npm run minify"
   },
   "repository": {
     "type": "git",
@@ -44,6 +45,7 @@
   "devDependencies": {
     "@types/node": "^20.5.6",
     "@types/qrcode": "^1.5.1",
+    "jsmin": "^1.0.1",
     "typescript": "^5.2.2"
   }
 }