vita-playwright 1.2.3 → 1.2.4

package/README.md

@@ -27,13 +27,12 @@ VITA Playwright helpers are written in Typescript with playwright support and a
       - [uploadAFile](#uploadafile)
       - [getElementRefByRole](#getelementrefbyrole)
   - [Utilities](#utilities)
-    - [Excel Utilities](#excel-utilities)
+    - [Document Utilities](#document-utilities)
       - [readData](#readdata)
       - [readDataFromExcelorCSV](#readdatafromexcelorcsv)
       - [filterData](#filterdata)
       - [updateExcelData](#updateexceldata)
       - [deleteAllFilesUnderDir](#deleteallfilesunderdir)
-    - [PDF Utilities](#pdf-utilities)
       - [readPdfFile](#readpdffile)
     - [Lighthouse Utilities](#lighthouse-utilities)
       - [auditLightHouse](#auditlighthouse)
@@ -76,15 +75,73 @@ const postResponse = await ApiHelper.post(url, header, payload);
 ```
 #### ApiHelpers.post
 ```ts
-// will be added in next versions.
+/**
+ * @description: Post call with endpoint, headers and data.
+ * @param {string}  apiEndPoint - API end point.
+ * @param {string}  headers  - headers contains authentication keys, application type etc..
+ * @param {string}  payload  - payload data
+ * @returns {Promise<reponse>} - returns Promise of reponse
+ */
+import { ApiHelper } from "vita-playwright";
+const headers= {
+        "content-type": "application/json; charset=utf-8",
+        "Accept": "*/*"
+        };
+const payload = {
+  "key":"value"
+};
+const apiEndPoint = "https://admin.googleapis.com/discovery/rest?version=datatransfer_v1";
+
+await ApiHelper.post(
+        apiEndPoint,
+        headers,
+        payload
+      );
 ```
 #### ApiHelpers.get
 ```ts
-// will be added in next versions.
+/**
+ * @description: Get call with endpoint and headers.
+ * @param {string}  apiEndPoint - API end point.
+ * @param {string}  headers  - headers contains authentication keys, application type etc..
+ * @returns {Promise<reponse>} - returns Promise of reponse
+ */
+import { ApiHelper } from "vita-playwright";
+const headers= {
+        "content-type": "application/json; charset=utf-8",
+        "Accept": "*/*"
+        };
+const apiEndPoint = "https://admin.googleapis.com/discovery/rest?version=datatransfer_v1";
+
+await ApiHelper.get(
+        apiEndPoint,
+        headers,
+      );
 ```
 #### ApiHelpers.put
 ```ts
-// will be added in next versions.
+/**
+ * @description: Put call with endpoint, headers and data and it will insert the data.
+ * @param {string}  apiEndPoint - API end point.
+ * @param {string}  headers  - headers contains authentication keys, application type etc..
+ * @param {string}  payload  - payload data
+ * @returns {Promise<reponse>} - returns Promise of reponse
+ */
+import { ApiHelper } from "vita-playwright";
+const headers= {
+        "content-type": "application/json; charset=utf-8",
+        "Accept": "*/*"
+        };
+const data = {
+  "key":"value"
+};
+const apiEndPoint = "https://admin.googleapis.com/discovery/rest?version=datatransfer_v1";
+
+await ApiHelper.put(
+        apiEndPoint,
+        headers,
+        data
+      );
 ```
 
 ### UI Helpers
@@ -120,7 +177,13 @@ __Note__: getElementRefByRole() method will work for all types of roles, example
  * @param {string}  data  - Text to be set to inputbox
  * @returns {Promise<void>} - returns Promise of void
  */
-async filltheData(locator: any, data: any)
+async filltheData(locator: any, data: any);
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  await this.filltheData("locator/xpath/css selector", "data to set into inputbox");
+}
 ```
 #### clickonWebElement
 ```ts
@@ -130,6 +193,12 @@ async filltheData(locator: any, data: any)
  * @returns {Promise<void>} - returns Promise of void
  */
 async clickonWebElement(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  await this.clickonWebElement("locator/xpath/css selector");
+}
 ```
 #### getInnerHTML
 ```ts
@@ -139,6 +208,13 @@ async clickonWebElement(locator: any)
  * @returns {string} - returns inner html string
  */
 async getInnerHTML(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.getInnerHTML("locator/xpath/css selector"));
+  //output: inner HTML of given selector
+}
 ```
 #### getInnerText
 ```ts
@@ -148,6 +224,13 @@ async getInnerHTML(locator: any)
  * @returns {string} - returns inner text string
  */
 async getInnerText(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.getInnerText("locator/xpath/css selector"));
+  //output: inner Text of given selector
+}
 ```
 #### getText
 ```ts
@@ -157,6 +240,13 @@ async getInnerText(locator: any)
  * @returns {string} - returns text string
  */
 async getText(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.getText("locator/xpath/css selector"));
+  //output: Text of given selector
+}
 ```
 #### getAttribute
 ```ts
@@ -166,7 +256,14 @@ async getText(locator: any)
  * @param {string} attribute - html attribute to get value
  * @returns {string} - returns text string
  */
-async getAttribute(locator: any, attribute: any))
+async getAttribute(locator: any, attribute: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.getAttribute("locator/xpath/css selector", "class"));
+  //output: returns locator class value
+}
 ```
 #### evaluateJS
 ```ts
@@ -180,6 +277,13 @@ async getAttribute(locator: any, attribute: any))
  * @returns {boolean} - returns true/false
  */
 async isElementPresent(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.isElementPresent("locator/xpath/css selector"));
+  //output: returns true if given locator is present in the dom
+}
 ```
 #### isElementEnabled
 ```ts
@@ -189,6 +293,13 @@ async isElementPresent(locator: any)
  * @returns {boolean} - returns true/false
  */
 async isElementEnabled(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.isElementEnabled("locator/xpath/css selector"));
+  //output: returns true if given locator is enabled in the dom
+}
 ```
 #### waitTillElementIsVisible
 ```ts
@@ -199,6 +310,13 @@ async isElementEnabled(locator: any)
  * @returns {Promise<void>} - returns Promise of void
  */
 async waitTillElementIsVisible(elementSelector: any, waitTime = 60000)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  await this.waitTillElementIsVisible("locator/xpath/css selector", 100000);
+  //output: wait for given locator to be available in the dom
+}
 ```
 #### getInputBoxValue
 ```ts
@@ -208,6 +326,13 @@ async waitTillElementIsVisible(elementSelector: any, waitTime = 60000)
  * @returns {string} - returns text string
  */
 async getInputBoxValue(locator: any)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  console.log(await this.getInputBoxValue("locator/xpath/css selector"));
+  //output: returns inputbox value
+}
 ```
 #### downloadAFile
 ```ts
@@ -218,6 +343,14 @@ async getInputBoxValue(locator: any)
  * @returns {Promise<void>} - returns Promise of void
  */
 async downloadAFile(downloadButton: String, filePath: string)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  const filePath = path.resolve(config.use.downloadsPath, downloadFileName);
+  await this.downloadAFile(downloadButtonRef, filePath);
+  //will wait for download completes and saves in to given filepath with custom name
+}
 ```
 #### uploadAFile
 ```ts
@@ -228,6 +361,14 @@ async downloadAFile(downloadButton: String, filePath: string)
  * @returns {Promise<void>} - returns Promise of void
  */
 async uploadAFile(uploadButton: String, uploadFilePath: String)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  const filePath = path.resolve(config.use.downloadsPath, UploadFileName);
+  await this.uploadAFile(UploadButtonRef, filePath);
+  //will wait for upload completes
+}
 ```
 #### getElementRefByRole
 ```ts
@@ -238,12 +379,20 @@ async uploadAFile(uploadButton: String, uploadFilePath: String)
  * @returns {Promise<void>} - returns Promise of void
  */
 async getElementRefByRole(roleType: string, roleName: string)
+
+Usage:
+import { UIHelper } from 'vita-playwright'
+class UserClass extends UIHelper{
+  await this.getElementRefByRole("link", "Dashboard");
+  await this.getElementRefByRole("button", "Jobs");
+  await this.getElementRefByRole("checkbox", "jobName");
+}
 ```
 
 ## Utilities
 vita-playwright also provides utilities for Excel, Pdf, Date, Email and Lighthosue for perfomace.
 
-### Excel Utilities
+### Document Utilities
 
 You can access rows and columns in order to change size, hide/show, or access cells within:
 
@@ -299,9 +448,6 @@ static async updateExcelData(filePath: string, sheetname: string)
  */
 static async deleteAllFilesUnderDir(filePath: string, sheetname: string)
 ```
-### PDF Utilities
-PDF reading related utilities
-
 #### readPdfFile
 ```ts
 /**
@@ -311,6 +457,7 @@ PDF reading related utilities
  */
 static async readPdfFile(filePath: string)
 ```
+
 ### Lighthouse Utilities
 Lighthouse utilities are used to perform Lighthouse performace testing provided by Google.
 

package/dist/index.d.ts

@@ -3,9 +3,9 @@ import { ApiHelper } from "./src/helpers/api-helpers";
 import { TokenGenerators } from "./src/utils/api_axios";
 import { AzureStorageMethods } from "./src/utils/azure_storage_methods";
 import { Comparisions } from "./src/utils/comparisions";
-import { ExcelUtility } from "./src/utils/excel_utility";
+import { DocumentUtility } from "./src/utils/document_utility";
 import { KeyVaultMethods } from "./src/utils/keyvault_methods";
 import { TestData } from "./src/utils/test_data";
 import { XmlToJson } from "./src/utils/xmlToJson";
 import { LightHouseUtility } from "./src/utils/lighhouse_utility";
-export { UIHelper, ApiHelper, TokenGenerators, AzureStorageMethods, Comparisions, ExcelUtility, KeyVaultMethods, TestData, XmlToJson, LightHouseUtility };
+export { UIHelper, ApiHelper, TokenGenerators, AzureStorageMethods, Comparisions, DocumentUtility, KeyVaultMethods, TestData, XmlToJson, LightHouseUtility };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LightHouseUtility = exports.XmlToJson = exports.TestData = exports.KeyVaultMethods = exports.ExcelUtility = exports.Comparisions = exports.AzureStorageMethods = exports.TokenGenerators = exports.ApiHelper = exports.UIHelper = void 0;
+exports.LightHouseUtility = exports.XmlToJson = exports.TestData = exports.KeyVaultMethods = exports.DocumentUtility = exports.Comparisions = exports.AzureStorageMethods = exports.TokenGenerators = exports.ApiHelper = exports.UIHelper = void 0;
 const ui_helpers_1 = require("./src/helpers/ui-helpers");
 Object.defineProperty(exports, "UIHelper", { enumerable: true, get: function () { return ui_helpers_1.UIHelper; } });
 const api_helpers_1 = require("./src/helpers/api-helpers");
@@ -11,8 +11,8 @@ const azure_storage_methods_1 = require("./src/utils/azure_storage_methods");
 Object.defineProperty(exports, "AzureStorageMethods", { enumerable: true, get: function () { return azure_storage_methods_1.AzureStorageMethods; } });
 const comparisions_1 = require("./src/utils/comparisions");
 Object.defineProperty(exports, "Comparisions", { enumerable: true, get: function () { return comparisions_1.Comparisions; } });
-const excel_utility_1 = require("./src/utils/excel_utility");
-Object.defineProperty(exports, "ExcelUtility", { enumerable: true, get: function () { return excel_utility_1.ExcelUtility; } });
+const document_utility_1 = require("./src/utils/document_utility");
+Object.defineProperty(exports, "DocumentUtility", { enumerable: true, get: function () { return document_utility_1.DocumentUtility; } });
 const keyvault_methods_1 = require("./src/utils/keyvault_methods");
 Object.defineProperty(exports, "KeyVaultMethods", { enumerable: true, get: function () { return keyvault_methods_1.KeyVaultMethods; } });
 const test_data_1 = require("./src/utils/test_data");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAYhD,yFAZK,qBAAQ,OAYL;AAXZ,2DAAsD;AAYlD,0FAZK,uBAAS,OAYL;AAXb,qDAAwD;AAYpD,gGAZK,2BAAe,OAYL;AAXnB,6EAAwE;AAYpE,oGAZK,2CAAmB,OAYL;AAXvB,2DAAwD;AAYpD,6FAZK,2BAAY,OAYL;AAXhB,6DAAyD;AAYrD,6FAZK,4BAAY,OAYL;AAXhB,mEAA+D;AAY3D,gGAZK,kCAAe,OAYL;AAXnB,qDAAiD;AAY7C,yFAZK,oBAAQ,OAYL;AAXZ,qDAAkD;AAY9C,0FAZK,qBAAS,OAYL;AAXb,qEAAkE;AAY9D,kGAZK,qCAAiB,OAYL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAYhD,yFAZK,qBAAQ,OAYL;AAXZ,2DAAsD;AAYlD,0FAZK,uBAAS,OAYL;AAXb,qDAAwD;AAYpD,gGAZK,2BAAe,OAYL;AAXnB,6EAAwE;AAYpE,oGAZK,2CAAmB,OAYL;AAXvB,2DAAwD;AAYpD,6FAZK,2BAAY,OAYL;AAXhB,mEAA+D;AAY3D,gGAZK,kCAAe,OAYL;AAXnB,mEAA+D;AAY3D,gGAZK,kCAAe,OAYL;AAXnB,qDAAiD;AAY7C,yFAZK,oBAAQ,OAYL;AAXZ,qDAAkD;AAY9C,0FAZK,qBAAS,OAYL;AAXb,qEAAkE;AAY9D,kGAZK,qCAAiB,OAYL"}

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

@@ -4,5 +4,6 @@ export declare class DocumentUtility {
     static readDataFromExcelorCSV(filePath: string, sheetname: string): Promise<unknown[]>;
     static filterData(filePath: string, sheetName: string, filterObject: object): Promise<unknown[]>;
     static updateExcelData(filePath: string, sheetName: string, exportData: Array<object>): Promise<void>;
-    static deleteAllFilesUnderDIr(dirPath: string): Promise<void>;
+    static deleteAllFilesUnderDir(dirPath: string): Promise<void>;
+    static readPdfFile(filePath: string): Promise<unknown>;
 }

package/dist/src/utils/document_utility.js

@@ -17,6 +17,7 @@ const xlsx_1 = __importDefault(require("xlsx"));
 const lodash_1 = __importDefault(require("lodash"));
 const promises_1 = __importDefault(require("node:fs/promises"));
 const node_path_1 = __importDefault(require("node:path"));
+const pdfreader_1 = require("pdfreader");
 class DocumentUtility {
     static readData(filePath) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -59,13 +60,28 @@ class DocumentUtility {
             xlsx_1.default.writeFile(workbook, filePath);
         });
     }
-    static deleteAllFilesUnderDIr(dirPath) {
+    static deleteAllFilesUnderDir(dirPath) {
         return __awaiter(this, void 0, void 0, function* () {
             for (const file of yield promises_1.default.readdir(dirPath)) {
                 yield promises_1.default.unlink(node_path_1.default.join(dirPath, file));
             }
         });
     }
+    static readPdfFile(filePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const items = [];
+            return new Promise((resolve, reject) => {
+                new pdfreader_1.PdfReader().parseFileItems(filePath, (err, item) => {
+                    if (err)
+                        reject(err);
+                    else if (!item)
+                        resolve(items);
+                    else if (item.text)
+                        items.push(item.text);
+                });
+            });
+        });
+    }
 }
 exports.DocumentUtility = DocumentUtility;
 //# sourceMappingURL=document_utility.js.map

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,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;CAGJ;AA/CD,0CA+CC"}
+{"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"}

package/index.ts

@@ -3,7 +3,7 @@ import { ApiHelper } from "./src/helpers/api-helpers";
 import { TokenGenerators } from "./src/utils/api_axios";
 import { AzureStorageMethods } from "./src/utils/azure_storage_methods";
 import { Comparisions } from "./src/utils/comparisions";
-import { ExcelUtility } from "./src/utils/excel_utility";
+import { DocumentUtility } from "./src/utils/document_utility";
 import { KeyVaultMethods } from "./src/utils/keyvault_methods";
 import { TestData } from "./src/utils/test_data";
 import { XmlToJson } from "./src/utils/xmlToJson";
@@ -15,7 +15,7 @@ export {
     TokenGenerators,
     AzureStorageMethods,
     Comparisions,
-    ExcelUtility,
+    DocumentUtility,
     KeyVaultMethods,
     TestData,
     XmlToJson,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vita-playwright",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "email": "noreply_testautomation@vialto.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/utils/{excel_utility.ts → document_utility.ts}

@@ -2,7 +2,9 @@ import XLSX from 'xlsx';
 import _ from 'lodash';
 import fs from "node:fs/promises";
 import path from "node:path";
-export class ExcelUtility {
+import { PdfReader } from "pdfreader";
+
+export class DocumentUtility {
 
     static async readData(filePath: string) {
         return XLSX.readFile(filePath, { cellDates: true, bookVBA: true, sheetStubs: true, cellNF: true });
@@ -13,7 +15,7 @@ export class ExcelUtility {
             raw: false,
             dateNF: `yyyy/mm/dd` // <--- need dateNF in sheet_to_json options (note the escape chars)
           }
-        const workbook = await ExcelUtility.readData(filePath);
+        const workbook = await DocumentUtility.readData(filePath);
         const sheet_name_list = workbook.SheetNames;
         sheetname = (sheetname === undefined ? sheet_name_list[0] : sheetname);
         return XLSX.utils.sheet_to_json(workbook.Sheets[sheet_name_list[0]], jsonOpts);
@@ -32,12 +34,12 @@ export class ExcelUtility {
     }
 
     static async filterData(filePath: string, sheetName: string, filterObject: object) {
-        let fileData = await ExcelUtility.readData(filePath);
+        let fileData = await DocumentUtility.readData(filePath);
         return _.filter(XLSX.utils.sheet_to_json(fileData.Sheets[sheetName]), filterObject)
     }
 
     static async updateExcelData(filePath: string, sheetName: string, exportData: Array<object>) {
-        const workbook = await ExcelUtility.readData(filePath);
+        const workbook = await DocumentUtility.readData(filePath);
         workbook.Sheets[sheetName] = XLSX.utils.json_to_sheet(exportData);
         XLSX.writeFile(workbook, filePath);
     }
@@ -48,5 +50,16 @@ export class ExcelUtility {
         }
     }
 
+    static async readPdfFile(filePath: string) {
+        const items = [];
+        return new Promise((resolve, reject) => {
+            new PdfReader().parseFileItems(filePath, (err, item) => {
+                if (err) reject(err);
+                else if (!item) resolve(items);
+                else if (item.text) items.push(item.text);
+            });
+        });
+    }
+
 
 }