upiqr 1.3.5 → 1.3.8

package/README.md

@@ -67,7 +67,6 @@ Internally using `qrcode` for QR Generation. And, it accepts [second optional pa
 
 ```
 
-
 <!--- [![Code Coverage][codecov-img]][codecov-url] --->
 
 [build-img]:https://github.com/bhar4t/upiqr/actions/workflows/main.yml/badge.svg
@@ -85,4 +84,4 @@ Internally using `qrcode` for QR Generation. And, it accepts [second optional pa
 [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
+[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,3 +1,9 @@
 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>;

package/dist/types/upiqr.d.ts

@@ -1,5 +1,15 @@
+/**
+ * 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;
@@ -12,6 +22,9 @@ export interface UPIIntentParams {
     currency?: string;
     transactionRefUrl?: string;
 }
+/**
+ * Result of the UPI QR code generation.
+ */
 export interface QRResult {
     qr: Base64<ImageType>;
     intent: string;

package/package.json

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