vita-playwright 1.3.3 → 1.3.5

package/dist/src/helpers/api-helpers.d.ts

@@ -1,5 +1,25 @@
 export declare class ApiHelper {
-    static post(url: any, header: any, payload: any): Promise<any>;
-    static get(url: any, header: any): Promise<any>;
-    static put(url: any, header: any, payload: any): Promise<any>;
+    /**
+     * @description: Post call with endpoint, headers and data.
+     * @param {string}  apiEndPoint - API end point.
+     * @param {string}  header  - header contains authentication keys, application type etc..
+     * @param {string}  payload  - payload data
+     * @returns {Promise<reponse>} - returns Promise of reponse
+     */
+    static post(apiEndPoint: any, header: any, payload: any): Promise<any>;
+    /**
+     * @description: Get call with endpoint and headers.
+     * @param {string}  apiEndPoint - API end point.
+     * @param {string}  header  - header contains authentication keys, application type etc..
+     * @returns {Promise<reponse>} - returns Promise of reponse
+     */
+    static get(apiEndPoint: any, header: any): Promise<any>;
+    /**
+     * @description: Put call with endpoint, headers and data and it will insert the data.
+     * @param {string}  apiEndPoint - API end point.
+     * @param {string}  header  - headers contains authentication keys, application type etc..
+     * @param {string}  payload  - payload data
+     * @returns {Promise<reponse>} - returns Promise of reponse
+     */
+    static put(apiEndPoint: any, header: any, payload: any): Promise<any>;
 }

package/dist/src/helpers/api-helpers.js

@@ -12,11 +12,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiHelper = void 0;
 const api_axios_1 = require("../utils/api_axios");
 class ApiHelper {
-    static post(url, header, payload) {
+    /**
+     * @description: Post call with endpoint, headers and data.
+     * @param {string}  apiEndPoint - API end point.
+     * @param {string}  header  - header contains authentication keys, application type etc..
+     * @param {string}  payload  - payload data
+     * @returns {Promise<reponse>} - returns Promise of reponse
+     */
+    static post(apiEndPoint, header, payload) {
         return __awaiter(this, void 0, void 0, function* () {
             var config = {
                 method: 'post',
-                url: url,
+                url: apiEndPoint,
                 headers: header,
                 data: payload
             };
@@ -24,22 +31,35 @@ class ApiHelper {
             return response;
         });
     }
-    static get(url, header) {
+    /**
+     * @description: Get call with endpoint and headers.
+     * @param {string}  apiEndPoint - API end point.
+     * @param {string}  header  - header contains authentication keys, application type etc..
+     * @returns {Promise<reponse>} - returns Promise of reponse
+     */
+    static get(apiEndPoint, header) {
         return __awaiter(this, void 0, void 0, function* () {
             var config = {
                 method: 'GET',
-                url: url,
+                url: apiEndPoint,
                 headers: header
             };
             var response = yield api_axios_1.TokenGenerators.request(config);
             return response;
         });
     }
-    static put(url, header, payload) {
+    /**
+     * @description: Put call with endpoint, headers and data and it will insert the data.
+     * @param {string}  apiEndPoint - API end point.
+     * @param {string}  header  - headers contains authentication keys, application type etc..
+     * @param {string}  payload  - payload data
+     * @returns {Promise<reponse>} - returns Promise of reponse
+     */
+    static put(apiEndPoint, header, payload) {
         return __awaiter(this, void 0, void 0, function* () {
             var config = {
                 method: 'put',
-                url: url,
+                url: apiEndPoint,
                 headers: header,
                 data: payload
             };

package/dist/src/helpers/api-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-helpers.js","sourceRoot":"","sources":["../../../src/helpers/api-helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAqD;AAErD,MAAa,SAAS;IAElB,MAAM,CAAO,IAAI,CAAC,GAAQ,EAAE,MAAW,EAAE,OAAY;;YACjD,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,OAAO;aAChB,CAAC;YAEF,IAAI,QAAQ,GAAG,MAAM,2BAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED,MAAM,CAAO,GAAG,CAAC,GAAQ,EAAE,MAAW;;YAClC,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,MAAM;aAClB,CAAC;YAEF,IAAI,QAAQ,GAAG,MAAM,2BAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED,MAAM,CAAO,GAAG,CAAC,GAAQ,EAAE,MAAW,EAAE,OAAY;;YAChD,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,OAAO;aAChB,CAAC;YAEF,IAAI,QAAQ,GAAG,MAAM,2BAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CAEJ;AArCD,8BAqCC"}
+{"version":3,"file":"api-helpers.js","sourceRoot":"","sources":["../../../src/helpers/api-helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAqD;AAErD,MAAa,SAAS;IAElB;;;;;;OAMG;IACH,MAAM,CAAO,IAAI,CAAC,WAAgB,EAAE,MAAW,EAAE,OAAY;;YACzD,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,WAAW;gBAChB,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,OAAO;aAChB,CAAC;YAEF,IAAI,QAAQ,GAAG,MAAM,2BAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IACD;;;;;OAKG;IACH,MAAM,CAAO,GAAG,CAAC,WAAgB,EAAE,MAAW;;YAC1C,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,WAAW;gBAChB,OAAO,EAAE,MAAM;aAClB,CAAC;YAEF,IAAI,QAAQ,GAAG,MAAM,2BAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IACD;;;;;;OAMG;IACH,MAAM,CAAO,GAAG,CAAC,WAAgB,EAAE,MAAW,EAAE,OAAY;;YACxD,IAAI,MAAM,GAAG;gBACT,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,WAAW;gBAChB,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,OAAO;aAChB,CAAC;YAEF,IAAI,QAAQ,GAAG,MAAM,2BAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CAEJ;AAvDD,8BAuDC"}

package/dist/src/helpers/ui-helpers.d.ts

@@ -1,18 +1,89 @@
 export declare class UIHelper {
     page: any;
     constructor(page: any);
+    /**
+     * @description: sets the text in inputbox.
+     * @param {string}  locator - css selector/xpath of the inputbox.
+     * @param {string}  data  - Text to be set to inputbox
+     * @returns {Promise<void>} - returns Promise of void
+     */
     filltheData(locator: any, data: any): Promise<void>;
+    /**
+     * @description: click the given locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     clickonWebElement(locator: any): Promise<void>;
+    /**
+     * @description: returns inner html of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns inner html string
+     */
     getInnerHTML(locator: any): Promise<any>;
+    /**
+     * @description: returns inner text of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns inner text string
+     */
     getInnerText(locator: any): Promise<any>;
+    /**
+     * @description: returns text of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns text string
+     */
     getText(locator: any): Promise<any>;
+    /**
+     * @description: returns given attribute value of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @param {string} attribute - html attribute to get value
+     * @returns {string} - returns text string
+     */
     getAttribute(locator: any, attribute: any): Promise<any>;
     evaluateJS(jsDOM: any): Promise<any>;
+    /**
+     * @description: verifies given locator element is displayed or not.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {boolean} - returns true/false
+     */
     isElementPresent(locator: any): Promise<any>;
+    /**
+     * @description: verifies given locator element is enabled or not.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {boolean} - returns true/false
+     */
     isElementEnabled(locator: any): Promise<any>;
+    /**
+     * @description: waits until locator element visibles.
+     * @param {elementReference}  elementSelector - element reference.
+     * @param {number} wait time
+     * @returns {Promise<void>} - returns Promise of void
+     */
     waitTillElementIsVisible(elementSelector: any, waitTime?: number): Promise<void>;
+    /**
+     * @description: returns value of inputbox.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns text string
+     */
     getInputBoxValue(locator: any): Promise<any>;
+    /**
+     * @description: wait untill download process completes and save file with custom name.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     downloadAFile(downloadButton: String, filePath: string): Promise<void>;
+    /**
+     * @description: wait untill upload process completes and save file with custom name.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     uploadAFile(uploadButton: String, uploadFilePath: String): Promise<void>;
+    /**
+     * @description: will perform click action.
+     * @param {string}  roleType - example: "alert"|"alertdialog"|"application"|"article"|"banner"|"blockquote"|"button"|"caption"|"cell"|"checkbox"|"code"|"columnheader"|"combobox"|"complementary"|"contentinfo"|"definition"|"deletion"|"dialog"|"directory"|"document"|"emphasis"|"feed"|"figure"|"form"|"generic"|"grid"|"gridcell"|"group"|"heading"|"img"|"insertion"|"link"|"list"|"listbox"|"listitem"|"log"|"main"|"marquee"|"math"|"meter"|"menu"|"menubar"|"menuitem"|"menuitemcheckbox"|"menuitemradio"|"navigation"|"none"|"note"|"option"|"paragraph"|"presentation"|"progressbar"|"radio"|"radiogroup"|"region"|"row"|"rowgroup"|"rowheader"|"scrollbar"|"search"|"searchbox"|"separator"|"slider"|"spinbutton"|"status"|"strong"|"subscript"|"superscript"|"switch"|"tab"|"table"|"tablist"|"tabpanel"|"term"|"textbox"|"time"|"timer"|"toolbar"|"tooltip"|"tree"|"treegrid"|"treeitem".
+     * @param {string}  roleName - name of the element.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     getElementRefByRole(roleType: string, roleName: string): Promise<void>;
 }

package/dist/src/helpers/ui-helpers.js

@@ -15,6 +15,12 @@ class UIHelper {
     constructor(page) {
         this.page = page;
     }
+    /**
+     * @description: sets the text in inputbox.
+     * @param {string}  locator - css selector/xpath of the inputbox.
+     * @param {string}  data  - Text to be set to inputbox
+     * @returns {Promise<void>} - returns Promise of void
+     */
     filltheData(locator, data) {
         return __awaiter(this, void 0, void 0, function* () {
             if (data) {
@@ -24,6 +30,11 @@ class UIHelper {
             }
         });
     }
+    /**
+     * @description: click the given locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     clickonWebElement(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.page.locator(locator).scrollIntoViewIfNeeded();
@@ -31,6 +42,11 @@ class UIHelper {
             yield this.page.locator(locator).click();
         });
     }
+    /**
+     * @description: returns inner html of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns inner html string
+     */
     getInnerHTML(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.waitTillElementIsVisible(locator);
@@ -38,6 +54,11 @@ class UIHelper {
             return yield this.page.innerHTML(locator);
         });
     }
+    /**
+     * @description: returns inner text of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns inner text string
+     */
     getInnerText(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.waitTillElementIsVisible(locator);
@@ -45,6 +66,11 @@ class UIHelper {
             return yield this.page.locator(locator).innerText().trim();
         });
     }
+    /**
+     * @description: returns text of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns text string
+     */
     getText(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.waitTillElementIsVisible(locator);
@@ -52,6 +78,12 @@ class UIHelper {
             return yield this.page.locator(locator).textContent();
         });
     }
+    /**
+     * @description: returns given attribute value of locator element.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @param {string} attribute - html attribute to get value
+     * @returns {string} - returns text string
+     */
     getAttribute(locator, attribute) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.waitTillElementIsVisible(locator);
@@ -64,6 +96,11 @@ class UIHelper {
             return yield this.page.evaluate(jsDOM);
         });
     }
+    /**
+     * @description: verifies given locator element is displayed or not.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {boolean} - returns true/false
+     */
     isElementPresent(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             // console.log(typeof locator.toString());
@@ -79,17 +116,33 @@ class UIHelper {
             console.log(type.toString());
         });
     }
+    /**
+     * @description: verifies given locator element is enabled or not.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {boolean} - returns true/false
+     */
     isElementEnabled(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.page.locator(locator).scrollIntoViewIfNeeded();
             return yield this.page.locator(locator).isEnabled();
         });
     }
+    /**
+     * @description: waits until locator element visibles.
+     * @param {elementReference}  elementSelector - element reference.
+     * @param {number} wait time
+     * @returns {Promise<void>} - returns Promise of void
+     */
     waitTillElementIsVisible(elementSelector, waitTime = 60000) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.page.waitForSelector(elementSelector, { waitFor: 'visible', timeout: waitTime });
         });
     }
+    /**
+     * @description: returns value of inputbox.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @returns {string} - returns text string
+     */
     getInputBoxValue(locator) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.waitTillElementIsVisible(locator);
@@ -102,6 +155,12 @@ class UIHelper {
     //     robot.moveMouse(400, 20);
     //     robot.keyTap("enter");
     // }
+    /**
+     * @description: wait untill download process completes and save file with custom name.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     downloadAFile(downloadButton, filePath) {
         return __awaiter(this, void 0, void 0, function* () {
             const downloadPromise = this.page.waitForEvent('download');
@@ -112,6 +171,12 @@ class UIHelper {
             yield download.saveAs(filePath);
         });
     }
+    /**
+     * @description: wait untill upload process completes and save file with custom name.
+     * @param {string}  locator - css selector/xpath of the element.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     uploadAFile(uploadButton, uploadFilePath) {
         return __awaiter(this, void 0, void 0, function* () {
             const fileChooserPromise = this.page.waitForEvent('filechooser');
@@ -120,6 +185,12 @@ class UIHelper {
             yield fileChooser.setFiles(uploadFilePath);
         });
     }
+    /**
+     * @description: will perform click action.
+     * @param {string}  roleType - example: "alert"|"alertdialog"|"application"|"article"|"banner"|"blockquote"|"button"|"caption"|"cell"|"checkbox"|"code"|"columnheader"|"combobox"|"complementary"|"contentinfo"|"definition"|"deletion"|"dialog"|"directory"|"document"|"emphasis"|"feed"|"figure"|"form"|"generic"|"grid"|"gridcell"|"group"|"heading"|"img"|"insertion"|"link"|"list"|"listbox"|"listitem"|"log"|"main"|"marquee"|"math"|"meter"|"menu"|"menubar"|"menuitem"|"menuitemcheckbox"|"menuitemradio"|"navigation"|"none"|"note"|"option"|"paragraph"|"presentation"|"progressbar"|"radio"|"radiogroup"|"region"|"row"|"rowgroup"|"rowheader"|"scrollbar"|"search"|"searchbox"|"separator"|"slider"|"spinbutton"|"status"|"strong"|"subscript"|"superscript"|"switch"|"tab"|"table"|"tablist"|"tabpanel"|"term"|"textbox"|"time"|"timer"|"toolbar"|"tooltip"|"tree"|"treegrid"|"treeitem".
+     * @param {string}  roleName - name of the element.
+     * @returns {Promise<void>} - returns Promise of void
+     */
     getElementRefByRole(roleType, roleName) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.page.getByRole(roleType, { name: roleName }).click();

package/dist/src/helpers/ui-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"ui-helpers.js","sourceRoot":"","sources":["../../../src/helpers/ui-helpers.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;AAE9B,MAAa,QAAQ;IAGjB,YAAY,IAAS;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAEK,WAAW,CAAC,OAAY,EAAE,IAAS;;YAErC,IAAI,IAAI,EAAE;gBACN,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;gBAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;gBAC1D,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAE/C;QAEL,CAAC;KAAA;IAEK,iBAAiB,CAAC,OAAY;;YAChC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QAE7C,CAAC;KAAA;IAEK,YAAY,CAAC,OAAY;;YAC3B,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC;KAAA;IAGK,YAAY,CAAC,OAAY;;YAC3B,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC;QAC/D,CAAC;KAAA;IAEK,OAAO,CAAC,OAAY;;YACtB,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QAE1D,CAAC;KAAA;IAEK,YAAY,CAAC,OAAY,EAAE,SAAc;;YAC3C,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAEnE,CAAC;KAAA;IAEK,UAAU,CAAC,KAAU;;YACvB,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE3C,CAAC;KAAA;IAEK,gBAAgB,CAAC,OAAY;;YAC/B,0CAA0C;YAC1C,IAAI,IAAI,GAAG,OAAO,OAAO,CAAC;YAC1B,IAAI,IAAI,KAAK,QAAQ,EAAE;gBACnB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;gBAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;aACvD;iBAAM,IAAI,IAAI,KAAK,QAAQ,EAAE;gBAC1B,OAAO,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;aACpC;YAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEjC,CAAC;KAAA;IAEK,gBAAgB,CAAC,OAAY;;YAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QAExD,CAAC;KAAA;IAEK,wBAAwB,CAAC,eAAoB,EAAE,QAAQ,GAAG,KAAK;;YACjE,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAA;QAC/F,CAAC;KAAA;IAEK,gBAAgB,CAAC,OAAY;;YAC/B,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QACxC,CAAC;KAAA;IAEJ,oCAAoC;IACjC,4CAA4C;IAC5C,gCAAgC;IAChC,6BAA6B;IAC7B,IAAI;IAEE,aAAa,CAAC,cAAsB,EAAE,QAAgB;;YACxD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;YAC7C,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;YACvC,4CAA4C;YAC5C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/C,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;KAAA;IAEK,WAAW,CAAC,YAAoB,EAAE,cAAsB;;YAC1D,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YACjE,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC;YAC7C,MAAM,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEK,mBAAmB,CAAC,QAAgB,EAAE,QAAgB;;YACxD,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;QACpE,CAAC;KAAA;CAEJ;AAlHD,4BAkHC"}
+{"version":3,"file":"ui-helpers.js","sourceRoot":"","sources":["../../../src/helpers/ui-helpers.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;AAE9B,MAAa,QAAQ;IAGjB,YAAY,IAAS;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACG,WAAW,CAAC,OAAY,EAAE,IAAS;;YAErC,IAAI,IAAI,EAAE;gBACN,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;gBAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;gBAC1D,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAE/C;QAEL,CAAC;KAAA;IACD;;;;OAIG;IACG,iBAAiB,CAAC,OAAY;;YAChC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QAE7C,CAAC;KAAA;IACD;;;;OAIG;IACG,YAAY,CAAC,OAAY;;YAC3B,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC;KAAA;IAED;;;;OAIG;IACG,YAAY,CAAC,OAAY;;YAC3B,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC;QAC/D,CAAC;KAAA;IACD;;;;OAIG;IACG,OAAO,CAAC,OAAY;;YACtB,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QAE1D,CAAC;KAAA;IACD;;;;;OAKG;IACG,YAAY,CAAC,OAAY,EAAE,SAAc;;YAC3C,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAEnE,CAAC;KAAA;IAEK,UAAU,CAAC,KAAU;;YACvB,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE3C,CAAC;KAAA;IACD;;;;OAIG;IACG,gBAAgB,CAAC,OAAY;;YAC/B,0CAA0C;YAC1C,IAAI,IAAI,GAAG,OAAO,OAAO,CAAC;YAC1B,IAAI,IAAI,KAAK,QAAQ,EAAE;gBACnB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;gBAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;aACvD;iBAAM,IAAI,IAAI,KAAK,QAAQ,EAAE;gBAC1B,OAAO,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;aACpC;YAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEjC,CAAC;KAAA;IACD;;;;OAIG;IACG,gBAAgB,CAAC,OAAY;;YAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QAExD,CAAC;KAAA;IACD;;;;;OAKG;IACG,wBAAwB,CAAC,eAAoB,EAAE,QAAQ,GAAG,KAAK;;YACjE,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAA;QAC/F,CAAC;KAAA;IACD;;;;OAIG;IACG,gBAAgB,CAAC,OAAY;;YAC/B,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,CAAC;YAC1D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QACxC,CAAC;KAAA;IAED,oCAAoC;IACpC,4CAA4C;IAC5C,gCAAgC;IAChC,6BAA6B;IAC7B,IAAI;IACJ;;;;;OAKG;IACG,aAAa,CAAC,cAAsB,EAAE,QAAgB;;YACxD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;YAC7C,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;YACvC,4CAA4C;YAC5C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/C,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;KAAA;IACD;;;;;OAKG;IACG,WAAW,CAAC,YAAoB,EAAE,cAAsB;;YAC1D,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YACjE,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC;YAC7C,MAAM,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC/C,CAAC;KAAA;IACD;;;;;OAKG;IACG,mBAAmB,CAAC,QAAgB,EAAE,QAAgB;;YACxD,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;QACpE,CAAC;KAAA;CAEJ;AA7KD,4BA6KC"}

package/dist/src/utils/date_utilitites.d.ts

@@ -1,9 +1,47 @@
 import moment, { DurationInputArg1, DurationInputArg2 } from 'moment';
 export declare class Dateutility {
+    /**
+     * @description: returns date in required format.
+     * @param {string}  date - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @returns {string} - returns date in given format.
+     */
     static getDateInCustomFormat(date: any, format: string): string;
+    /**
+     * @description: adds no of days|months|years|hours|minutes|seconds from given date.
+     * @param {string}  date - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @param {string}  durationType - example days, months, years, hours, minutes, seconds.
+     * @param {string}  duration - no of days|months|years|hours|minutes|seconds.
+     * @returns {string} - returns date in given format.
+     */
     static getFutureDateInCustomFormat(date: any, format: string, durationType: DurationInputArg2, duration: DurationInputArg1): string;
+    /**
+     * @description: subtracts no of days|months|years|hours|minutes|seconds from given date.
+     * @param {string}  date - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @param {string}  durationType - example days, months, years, hours, minutes, seconds.
+     * @param {string}  duration - no of days|months|years|hours|minutes|seconds.
+     * @returns {string} - returns date in given format.
+     */
     static getPastDateInCustomFormat(date: any, format: string, durationType: DurationInputArg2, duration: DurationInputArg1): string;
+    /**
+     * @description: return min date from given dates.
+     * @param {Array<object<date,format>>}  datesArrayObject - array of dates in form of object example: [{date:10/01/2023, format: "DD/MM/YYYY"}, {date:20/01/2023, format: "DD/MM/YYYY"}].
+     * @returns {string} - return min date amount given dates example: 10/01/2023.
+     */
     static getMinDateFromMultipleDates(datesArrayObject: any): moment.Moment;
+    /**
+     * @description: return max date from given dates.
+     * @param {Array<object<date,format>>}  datesArrayObject - array of dates in form of object example: [{date:10/01/2023, format: "DD/MM/YYYY"}, {date:20/01/2023, format: "DD/MM/YYYY"}].
+     * @returns {string} - return max date amount given dates example: 20/01/2023.
+     */
     static getMaxDateFromMultipleDates(date1: any, date2: any): moment.Moment;
+    /**
+     * @description: returns no of days "lessthan|Greaterthan" from given date.
+     * @param {string}  fromDate - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @returns {string} - returns string which is no of days "lessthan|Greaterthan" from given date.
+     */
     static calculateRelativeDate(fromDate: any, format: string): string;
 }

package/dist/src/utils/date_utilitites.js

@@ -7,21 +7,59 @@ exports.Dateutility = void 0;
 const lodash_1 = require("lodash");
 const moment_1 = __importDefault(require("moment"));
 class Dateutility {
+    /**
+     * @description: returns date in required format.
+     * @param {string}  date - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @returns {string} - returns date in given format.
+     */
     static getDateInCustomFormat(date, format) {
         return (0, moment_1.default)(date).format(format);
     }
+    /**
+     * @description: adds no of days|months|years|hours|minutes|seconds from given date.
+     * @param {string}  date - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @param {string}  durationType - example days, months, years, hours, minutes, seconds.
+     * @param {string}  duration - no of days|months|years|hours|minutes|seconds.
+     * @returns {string} - returns date in given format.
+     */
     static getFutureDateInCustomFormat(date, format, durationType, duration) {
         return (0, moment_1.default)(date).add(duration, durationType).format(format);
     }
+    /**
+     * @description: subtracts no of days|months|years|hours|minutes|seconds from given date.
+     * @param {string}  date - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @param {string}  durationType - example days, months, years, hours, minutes, seconds.
+     * @param {string}  duration - no of days|months|years|hours|minutes|seconds.
+     * @returns {string} - returns date in given format.
+     */
     static getPastDateInCustomFormat(date, format, durationType, duration) {
         return (0, moment_1.default)(date).subtract(duration, durationType).format(format);
     }
+    /**
+     * @description: return min date from given dates.
+     * @param {Array<object<date,format>>}  datesArrayObject - array of dates in form of object example: [{date:10/01/2023, format: "DD/MM/YYYY"}, {date:20/01/2023, format: "DD/MM/YYYY"}].
+     * @returns {string} - return min date amount given dates example: 10/01/2023.
+     */
     static getMinDateFromMultipleDates(datesArrayObject) {
         return moment_1.default.min((0, lodash_1.map)(datesArrayObject, (obj) => (0, moment_1.default)(obj.date, obj.format)));
     }
+    /**
+     * @description: return max date from given dates.
+     * @param {Array<object<date,format>>}  datesArrayObject - array of dates in form of object example: [{date:10/01/2023, format: "DD/MM/YYYY"}, {date:20/01/2023, format: "DD/MM/YYYY"}].
+     * @returns {string} - return max date amount given dates example: 20/01/2023.
+     */
     static getMaxDateFromMultipleDates(date1, date2) {
         return moment_1.default.max(date1, date2);
     }
+    /**
+     * @description: returns no of days "lessthan|Greaterthan" from given date.
+     * @param {string}  fromDate - date in the form of string, example: 01/01/2023.
+     * @param {string}  format - format od date, example: DD/MM/YYYY.
+     * @returns {string} - returns string which is no of days "lessthan|Greaterthan" from given date.
+     */
     static calculateRelativeDate(fromDate, format) {
         return (0, moment_1.default)(fromDate, format).fromNow();
     }

package/dist/src/utils/date_utilitites.js.map

@@ -1 +1 @@
-{"version":3,"file":"date_utilitites.js","sourceRoot":"","sources":["../../../src/utils/date_utilitites.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA6B;AAC7B,oDAAsE;AACtE,MAAa,WAAW;IAEpB,MAAM,CAAC,qBAAqB,CAAC,IAAQ,EAAE,MAAc;QACjD,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,2BAA2B,CAAC,IAAS,EAAE,MAAc,EAAE,YAA8B,EAAE,QAA2B;QACrH,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,CAAC,yBAAyB,CAAC,IAAS,EAAE,MAAc,EAAE,YAA8B,EAAE,QAA2B;QACnH,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,2BAA2B,CAAC,gBAAqB;QACpD,OAAO,gBAAM,CAAC,GAAG,CAAC,IAAA,YAAG,EAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,gBAAM,EAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,CAAC,2BAA2B,CAAC,KAAU,EAAE,KAAU;QACrD,OAAO,gBAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,qBAAqB,CAAC,QAAa,EAAE,MAAc;QACtD,OAAO,IAAA,gBAAM,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9C,CAAC;CACJ;AAzBD,kCAyBC"}
+{"version":3,"file":"date_utilitites.js","sourceRoot":"","sources":["../../../src/utils/date_utilitites.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA6B;AAC7B,oDAAsE;AACtE,MAAa,WAAW;IAEpB;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,IAAS,EAAE,MAAc;QAClD,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,2BAA2B,CAAC,IAAS,EAAE,MAAc,EAAE,YAA+B,EAAE,QAA2B;QACtH,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,yBAAyB,CAAC,IAAS,EAAE,MAAc,EAAE,YAA+B,EAAE,QAA2B;QACpH,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAAC,gBAAqB;QACpD,OAAO,gBAAM,CAAC,GAAG,CAAC,IAAA,YAAG,EAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,gBAAM,EAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAAC,KAAU,EAAE,KAAU;QACrD,OAAO,gBAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,QAAa,EAAE,MAAc;QACtD,OAAO,IAAA,gBAAM,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9C,CAAC;CACJ;AA/DD,kCA+DC"}

package/dist/src/utils/document_utility.d.ts

@@ -1,9 +1,46 @@
 import XLSX from 'xlsx';
 export declare class DocumentUtility {
+    /**
+     * @description: it will take excel file path as input and will return excel Workbook object.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @returns {Promise<Workbook>} - returns Promise, if we resolves and will get Workbook object
+     */
     static readData(filePath: string): Promise<XLSX.WorkBook>;
+    /**
+     * @description: it will take excel file path and sheetname as input and will return array of objects.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @param {string}  sheetname - name of the sheet name and it is optional. For CSV files no need pass this parameter.
+     * @returns {Promise<Array<Object>>} - returns Promise, if we resolves and will get Array of Json objects.
+     * [{startDate: '****',endDate: '****', employeeId: '****',CompanyToken: '******'}]
+     */
     static readDataFromExcelorCSV(filePath: string, sheetname: string): Promise<unknown[]>;
+    /**
+     * @description: it will filter excel data and will return filtered array of objects.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @param {string}  sheetname - name of the sheet name and it is optional. For CSV files no need pass this parameter.
+     * @param {Object}  filterObject - {column Name:Row value} key:value pair. example: {startDate: '****'}
+     * @returns {Promise<Array<Object>>} - returns Promise, if we resolves and will get filtered Array of Json objects.
+     * [{startDate: '****',endDate: '****', employeeId: '****',CompanyToken: '******'}]
+     */
     static filterData(filePath: string, sheetName: string, filterObject: object): Promise<unknown[]>;
+    /**
+     * @description: it will modify/update excel file based on input data.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @param {string}  sheetname - name of the sheet name and it is optional. For CSV files no need pass this parameter.
+     * @param {Array<Object>}  exportData - excel modify data. example: [{startDate: '****',endDate: '****', employeeId: '****',CompanyToken: '******'}]
+     * @returns {Promise<void>} - returns void promise.
+     */
     static updateExcelData(filePath: string, sheetName: string, exportData: Array<object>): Promise<void>;
+    /**
+     * @description: it will delete all files under given directory.
+     * @param {string}  dirPath - Complete path of the directory which contain file, example: C:/resources.
+     * @returns {Promise<void>} - returns void promise.
+     */
     static deleteAllFilesUnderDir(dirPath: string): Promise<void>;
+    /**
+     * @description: it will take pdf file path as input and will return array of strings(each each line in pdf is each item in result array).
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.pdf.
+     * @returns { Array<string>} - returns array os string, each string represents each line in pdf
+     */
     static readPdfFile(filePath: string): Promise<unknown>;
 }

package/dist/src/utils/document_utility.js

@@ -19,11 +19,23 @@ const promises_1 = __importDefault(require("node:fs/promises"));
 const node_path_1 = __importDefault(require("node:path"));
 const pdfreader_1 = require("pdfreader");
 class DocumentUtility {
+    /**
+     * @description: it will take excel file path as input and will return excel Workbook object.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @returns {Promise<Workbook>} - returns Promise, if we resolves and will get Workbook object
+     */
     static readData(filePath) {
         return __awaiter(this, void 0, void 0, function* () {
             return xlsx_1.default.readFile(filePath, { cellDates: true, bookVBA: true, sheetStubs: true, cellNF: true });
         });
     }
+    /**
+     * @description: it will take excel file path and sheetname as input and will return array of objects.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @param {string}  sheetname - name of the sheet name and it is optional. For CSV files no need pass this parameter.
+     * @returns {Promise<Array<Object>>} - returns Promise, if we resolves and will get Array of Json objects.
+     * [{startDate: '****',endDate: '****', employeeId: '****',CompanyToken: '******'}]
+     */
     static readDataFromExcelorCSV(filePath, sheetname) {
         return __awaiter(this, void 0, void 0, function* () {
             const jsonOpts = {
@@ -47,12 +59,27 @@ class DocumentUtility {
             // })[0];
         });
     }
+    /**
+     * @description: it will filter excel data and will return filtered array of objects.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @param {string}  sheetname - name of the sheet name and it is optional. For CSV files no need pass this parameter.
+     * @param {Object}  filterObject - {column Name:Row value} key:value pair. example: {startDate: '****'}
+     * @returns {Promise<Array<Object>>} - returns Promise, if we resolves and will get filtered Array of Json objects.
+     * [{startDate: '****',endDate: '****', employeeId: '****',CompanyToken: '******'}]
+     */
     static filterData(filePath, sheetName, filterObject) {
         return __awaiter(this, void 0, void 0, function* () {
             let fileData = yield DocumentUtility.readData(filePath);
             return lodash_1.default.filter(xlsx_1.default.utils.sheet_to_json(fileData.Sheets[sheetName]), filterObject);
         });
     }
+    /**
+     * @description: it will modify/update excel file based on input data.
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.xlsx.
+     * @param {string}  sheetname - name of the sheet name and it is optional. For CSV files no need pass this parameter.
+     * @param {Array<Object>}  exportData - excel modify data. example: [{startDate: '****',endDate: '****', employeeId: '****',CompanyToken: '******'}]
+     * @returns {Promise<void>} - returns void promise.
+     */
     static updateExcelData(filePath, sheetName, exportData) {
         return __awaiter(this, void 0, void 0, function* () {
             const workbook = yield DocumentUtility.readData(filePath);
@@ -60,6 +87,11 @@ class DocumentUtility {
             xlsx_1.default.writeFile(workbook, filePath);
         });
     }
+    /**
+     * @description: it will delete all files under given directory.
+     * @param {string}  dirPath - Complete path of the directory which contain file, example: C:/resources.
+     * @returns {Promise<void>} - returns void promise.
+     */
     static deleteAllFilesUnderDir(dirPath) {
         return __awaiter(this, void 0, void 0, function* () {
             for (const file of yield promises_1.default.readdir(dirPath)) {
@@ -67,6 +99,11 @@ class DocumentUtility {
             }
         });
     }
+    /**
+     * @description: it will take pdf file path as input and will return array of strings(each each line in pdf is each item in result array).
+     * @param {string}  filePath - Complete path of the excel file, example: C:/resources/****.pdf.
+     * @returns { Array<string>} - returns array os string, each string represents each line in pdf
+     */
     static readPdfFile(filePath) {
         return __awaiter(this, void 0, void 0, function* () {
             const items = [];

package/dist/src/utils/document_utility.js.map

@@ -1 +1 @@
-{"version":3,"file":"document_utility.js","sourceRoot":"","sources":["../../../src/utils/document_utility.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,oDAAuB;AACvB,gEAAkC;AAClC,0DAA6B;AAC7B,yCAAsC;AAEtC,MAAa,eAAe;IAExB,MAAM,CAAO,QAAQ,CAAC,QAAgB;;YAClC,OAAO,cAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACvG,CAAC;KAAA;IAED,MAAM,CAAO,sBAAsB,CAAC,QAAgB,EAAE,SAAiB;;YACnE,MAAM,QAAQ,GAAG;gBACb,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,YAAY,CAAC,oEAAoE;aAC1F,CAAA;YACH,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC1D,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC5C,SAAS,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YACvE,OAAO,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAE/E,wEAAwE;YACxE,2DAA2D;YAC3D,8CAA8C;YAC9C,IAAI;YACJ,2CAA2C;YAC3C,mFAAmF;YACnF,6DAA6D;YAC7D,6DAA6D;YAC7D,yBAAyB;YACzB,aAAa;YACb,SAAS;QACb,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,QAAgB,EAAE,SAAiB,EAAE,YAAoB;;YAC7E,IAAI,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACxD,OAAO,gBAAC,CAAC,MAAM,CAAC,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;QACvF,CAAC;KAAA;IAED,MAAM,CAAO,eAAe,CAAC,QAAgB,EAAE,SAAiB,EAAE,UAAyB;;YACvF,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC1D,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAClE,cAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACvC,CAAC;KAAA;IAED,MAAM,CAAO,sBAAsB,CAAC,OAAe;;YAC/C,KAAK,MAAM,IAAI,IAAI,MAAM,kBAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC1C,MAAM,kBAAE,CAAC,MAAM,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;aAC7C;QACL,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,QAAgB;;YACrC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACnC,IAAI,qBAAS,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;oBACnD,IAAI,GAAG;wBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;yBAChB,IAAI,CAAC,IAAI;wBAAE,OAAO,CAAC,KAAK,CAAC,CAAC;yBAC1B,IAAI,IAAI,CAAC,IAAI;wBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;CAGJ;AA1DD,0CA0DC"}
+{"version":3,"file":"document_utility.js","sourceRoot":"","sources":["../../../src/utils/document_utility.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,oDAAuB;AACvB,gEAAkC;AAClC,0DAA6B;AAC7B,yCAAsC;AAEtC,MAAa,eAAe;IAExB;;;;OAIG;IACH,MAAM,CAAO,QAAQ,CAAC,QAAgB;;YAClC,OAAO,cAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACvG,CAAC;KAAA;IAED;;;;;;OAMG;IACH,MAAM,CAAO,sBAAsB,CAAC,QAAgB,EAAE,SAAiB;;YACnE,MAAM,QAAQ,GAAG;gBACb,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,YAAY,CAAC,oEAAoE;aAC5F,CAAA;YACD,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC1D,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC5C,SAAS,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YACvE,OAAO,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAE/E,wEAAwE;YACxE,2DAA2D;YAC3D,8CAA8C;YAC9C,IAAI;YACJ,2CAA2C;YAC3C,mFAAmF;YACnF,6DAA6D;YAC7D,6DAA6D;YAC7D,yBAAyB;YACzB,aAAa;YACb,SAAS;QACb,CAAC;KAAA;IAED;;;;;;;OAOG;IACH,MAAM,CAAO,UAAU,CAAC,QAAgB,EAAE,SAAiB,EAAE,YAAoB;;YAC7E,IAAI,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACxD,OAAO,gBAAC,CAAC,MAAM,CAAC,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;QACvF,CAAC;KAAA;IAED;;;;;;OAMG;IACH,MAAM,CAAO,eAAe,CAAC,QAAgB,EAAE,SAAiB,EAAE,UAAyB;;YACvF,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC1D,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAClE,cAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACvC,CAAC;KAAA;IAED;;;;OAIG;IACH,MAAM,CAAO,sBAAsB,CAAC,OAAe;;YAC/C,KAAK,MAAM,IAAI,IAAI,MAAM,kBAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC1C,MAAM,kBAAE,CAAC,MAAM,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;aAC7C;QACL,CAAC;KAAA;IAED;;;;OAIG;IACH,MAAM,CAAO,WAAW,CAAC,QAAgB;;YACrC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACnC,IAAI,qBAAS,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;oBACnD,IAAI,GAAG;wBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;yBAChB,IAAI,CAAC,IAAI;wBAAE,OAAO,CAAC,KAAK,CAAC,CAAC;yBAC1B,IAAI,IAAI,CAAC,IAAI;wBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;CAGJ;AA/FD,0CA+FC"}