upiqr 1.2.2 → 1.3.0

package/README.md

@@ -25,14 +25,11 @@ This package will work on client and server.
     payeeVPA: "bhar4t@upi",
     payeeName: "Bharat Sahu"
   })
-  .then((upi) => {
-    console.log(upi.qr);      // data:image/png;base64,eR0lGODP...
-    console.log(upi.intent);  // upi://pay?pa=bhar4t@upi&pn=Bharat..
+  .then(({ qr, intent  }) => {
+    console.log(qr);      // data:image/png;base64,eR0lGODP...
+    console.log(intent);  // upi://pay?pa=bhar4t@upi&pn=Bhar...
   })
-  .catch(err => {
-    console.log(err);
-  });
-
+  .catch(console.error)
 
 ```
 
@@ -54,9 +51,22 @@ This package will work on client and server.
 
 In table, fields requirement column is based on static QR, For dynamic QR you need to change more fields along with `payeeVPA` and `payeeName`.
 
-For a complete list of supported fields, refer to the [NPCI UPI Linking Specs](https://www.npci.org.in/PDF/npci/upi/circular/2017/Circular18_BankCompliances_to_enbaleUPIMerchantecosystem_0.pdf)
+For a complete list of supported fields, refer to the [NPCI UPI Linking Specs][upi-specs-url]
+
+### Customization:
+
+Internally using `qrcode` for QR Generation. And, it accepts [second optional param object][qr-code-options] for cusomizing the QR code.
+
+```js
+  upiqr(intentFields, {
+    color: {
+      dark: '#000000',
+      light: '#FFFFFF'
+    }
+  })
+
+```
 
-Internally using `qrcode` for QR Generation.
 
 <!--- [![Code Coverage][codecov-img]][codecov-url] --->
 
@@ -74,3 +84,5 @@ Internally using `qrcode` for QR Generation.
 [semantic-release-url]:https://github.com/semantic-release/semantic-release
 [commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
 [commitizen-url]:http://commitizen.github.io/cz-cli/
+[qr-code-options]:https://www.npmjs.com/package/qrcode#qr-code-options
+[upi-specs-url]:https://www.npci.org.in/PDF/npci/upi/circular/2017/Circular18_BankCompliances_to_enbaleUPIMerchantecosystem_0.pdf

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+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): Promise<QRResult>;
+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,44 +1,31 @@
 import QRCode from 'qrcode';
 function validateParams({ pa, pn }) {
+    var _a, _b;
     if (!pa || !pn)
         return "Virtual Payee's Address/Payee's Name is compulsory";
-    if ((pa === null || pa === void 0 ? void 0 : pa.length) < 5 || (pn === null || pn === void 0 ? void 0 : pn.length) < 4)
+    if (((_a = pa === null || pa === void 0 ? void 0 : pa.length) !== null && _a !== void 0 ? _a : 0) < 5 || ((_b = pn === null || pn === void 0 ? void 0 : pn.length) !== null && _b !== void 0 ? _b : 0) < 4)
         return "Virtual Payee's Address/Payee's Name is too short.";
     return '';
 }
 function buildUrl(params) {
-    let url = this, qs = "";
-    for (let [key, value] of Object.entries(params))
-        qs += encodeURIComponent(key) + "=" + encodeURIComponent(value) + "&";
-    if (qs.length > 0)
-        url = url + qs;
-    return url;
+    let qs = "";
+    for (let [key, value] of Object.entries(params)) {
+        if (value)
+            qs += encodeURIComponent(key) + "=" + encodeURIComponent(value) + "&";
+    }
+    if (!qs.length)
+        throw new Error("No valid parameters found to build UPI intent.");
+    return "upi://pay?" + qs.slice(0, -1); // Remove trailing '&'
 }
-export default function upiqr({ payeeVPA: pa, payeeName: pn, payeeMerchantCode: mc, transactionId: tid, transactionRef: tr, transactionNote: tn, amount: am, minimumAmount: mam, currency: cu, }) {
+export default function upiqr({ payeeVPA: pa, payeeName: pn, payeeMerchantCode: mc, transactionId: tid, transactionRef: tr, transactionNote: tn, amount: am, minimumAmount: mam, currency: cu, }, qrOptions) {
     return new Promise((resolve, reject) => {
-        let error = validateParams({ pa, pn });
+        const params = { pa, pn, am, mam, cu, mc, tid, tr, tn };
+        let error = validateParams(params);
         if (error)
-            reject(new Error(error));
-        let intent = "upi://pay?";
-        if (pa)
-            intent = buildUrl.call(intent, { pa, pn });
-        if (am)
-            intent = buildUrl.call(intent, { am });
-        if (mam)
-            intent = buildUrl.call(intent, { mam });
-        if (cu)
-            intent = buildUrl.call(intent, { cu });
-        if (mc)
-            intent = buildUrl.call(intent, { mc });
-        if (tid)
-            intent = buildUrl.call(intent, { tid });
-        if (tr)
-            intent = buildUrl.call(intent, { tr }); // tr: transactionRef upto 35 digits
-        if (tn)
-            intent = buildUrl.call(intent, { tn });
-        intent = intent.substring(0, intent.length - 1);
+            return reject(new Error(error));
+        const intent = buildUrl(params);
         QRCode
-            .toDataURL(intent)
+            .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,5 +1,5 @@
-type ImageType = 'png' | 'jpeg';
-export type Base64<imageType extends ImageType> = `data:image/${imageType};base64${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;
@@ -13,7 +13,6 @@ export interface UPIIntentParams {
     transactionRefUrl?: string;
 }
 export interface QRResult {
-    qr: string;
+    qr: Base64<ImageType>;
     intent: string;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "upiqr",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "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",