vasu-playwright-utils 0.1.0

package/dist/vasu-playwright-lib/utils/action-utils.js

@@ -0,0 +1,406 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clickByJS = exports.scrollLocatorIntoView = exports.uploadFiles = exports.downloadFile = exports.doubleClick = exports.dragAndDrop = exports.focus = exports.hover = exports.getAlertText = exports.dismissAlert = exports.acceptAlert = exports.selectByIndex = exports.selectByText = exports.selectByValues = exports.selectByValue = exports.uncheck = exports.check = exports.clear = exports.type = exports.fillAndEnter = exports.fill = exports.clickAndNavigate = exports.click = exports.wait = exports.goBack = exports.reloadPage = exports.waitForPageLoadState = exports.gotoURL = void 0;
+const tslib_1 = require("tslib");
+const page_utils_1 = require("./page-utils");
+const timeouts_1 = require("../constants/timeouts");
+const locator_utils_1 = require("./locator-utils");
+const loadstate_1 = require("../constants/loadstate");
+/**
+ * 1. Navigations: This section contains functions for navigating within a web page or between web pages.
+ * These functions include going to a URL, waiting for a page to load, reloading a page, and going back to a previous page.
+ */
+/**
+ * Navigates to the specified URL.
+ * @param {string} path - The URL to navigate to.
+ * @param {GotoOptions} options - The navigation options.
+ * @returns {Promise<null | Response>} - The navigation response or null if no response.
+ */
+function gotoURL(path, options = { waitUntil: loadstate_1.LOADSTATE }) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return yield (0, page_utils_1.getPage)().goto(path, options);
+    });
+}
+exports.gotoURL = gotoURL;
+/**
+ * Waits for a specific page load state.
+ * @param {NavigationOptions} options - The navigation options.
+ */
+function waitForPageLoadState(options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        let waitUntil = loadstate_1.LOADSTATE;
+        if ((options === null || options === void 0 ? void 0 : options.waitUntil) && options.waitUntil !== 'commit') {
+            waitUntil = options.waitUntil;
+        }
+        yield (0, page_utils_1.getPage)().waitForLoadState(waitUntil);
+    });
+}
+exports.waitForPageLoadState = waitForPageLoadState;
+/**
+ * Reloads the current page.
+ * @param {NavigationOptions} options - The navigation options.
+ */
+function reloadPage(options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield Promise.all([(0, page_utils_1.getPage)().reload(options), (0, page_utils_1.getPage)().waitForEvent('framenavigated')]);
+        yield waitForPageLoadState(options);
+    });
+}
+exports.reloadPage = reloadPage;
+/**
+ * Navigates back to the previous page.
+ * @param {NavigationOptions} options - The navigation options.
+ */
+function goBack(options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield Promise.all([(0, page_utils_1.getPage)().goBack(options), (0, page_utils_1.getPage)().waitForEvent('framenavigated')]);
+        yield waitForPageLoadState(options);
+    });
+}
+exports.goBack = goBack;
+/**
+ * Waits for a specified amount of time.
+ * @param {number} ms - The amount of time to wait in milliseconds.
+ */
+function wait(ms) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        // eslint-disable-next-line playwright/no-wait-for-timeout
+        yield (0, page_utils_1.getPage)().waitForTimeout(ms);
+    });
+}
+exports.wait = wait;
+/**
+ * 2. Actions: This section contains functions for interacting with elements on a web page.
+ * These functions include clicking, filling input fields, typing, clearing input fields, checking and unchecking checkboxes, selecting options in dropdowns, and more.
+ */
+/**
+ * Clicks on a specified element.
+ * @param {string | Locator} input - The element to click on.
+ * @param {ClickOptions} options - The click options.
+ */
+function click(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.click(options);
+    });
+}
+exports.click = click;
+/**
+ * Clicks on a specified element and waits for navigation.
+ * @param {string | Locator} input - The element to click on.
+ * @param {ClickOptions} options - The click options.
+ */
+function clickAndNavigate(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const timeout = (options === null || options === void 0 ? void 0 : options.timeout) || timeouts_1.STANDARD_TIMEOUT;
+        yield Promise.all([click(input, options), (0, page_utils_1.getPage)().waitForEvent('framenavigated', { timeout: timeout })]);
+        yield (0, page_utils_1.getPage)().waitForLoadState((options === null || options === void 0 ? void 0 : options.loadState) || loadstate_1.LOADSTATE, {
+            timeout: timeout,
+        });
+    });
+}
+exports.clickAndNavigate = clickAndNavigate;
+/**
+ * Fills a specified element with a value.
+ * @param {string | Locator} input - The element to fill.
+ * @param {string} value - The value to fill the element with.
+ * @param {FillOptions} options - The fill options.
+ */
+function fill(input, value, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.fill(value, options);
+    });
+}
+exports.fill = fill;
+/**
+ * Fills a specified element with a value and press Enter.
+ * @param {string | Locator} input - The element to fill.
+ * @param {string} value - The value to fill the element with.
+ * @param {FillOptions} options - The fill options.
+ */
+function fillAndEnter(input, value, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.fill(value, options);
+        yield locator.press('Enter');
+    });
+}
+exports.fillAndEnter = fillAndEnter;
+/**
+ * Types a value into a specified element.
+ * @param {string | Locator} input - The element to type into.
+ * @param {string} value - The value to type.
+ * @param {TypeOptions} options - The type options.
+ */
+function type(input, value, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.type(value, options);
+    });
+}
+exports.type = type;
+/**
+ * Clears the value of a specified element.
+ * @param {string | Locator} input - The element to clear.
+ * @param {ClearOptions} options - The clear options.
+ */
+function clear(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.clear(options);
+    });
+}
+exports.clear = clear;
+/**
+ * Checks a specified checkbox or radio button.
+ * @param {string | Locator} input - The checkbox or radio button to check.
+ * @param {CheckOptions} options - The check options.
+ */
+function check(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.check(options);
+    });
+}
+exports.check = check;
+/**
+ * Unchecks a specified checkbox or radio button.
+ * @param {string | Locator} input - The checkbox or radio button to uncheck.
+ * @param {CheckOptions} options - The uncheck options.
+ */
+function uncheck(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.uncheck(options);
+    });
+}
+exports.uncheck = uncheck;
+/**
+ * Selects an option in a dropdown by its value.
+ * @param {string | Locator} input - The dropdown to select an option in.
+ * @param {string} value - The value of the option to select.
+ * @param {SelectOptions} options - The select options.
+ */
+function selectByValue(input, value, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.selectOption({ value: value }, options);
+    });
+}
+exports.selectByValue = selectByValue;
+/**
+ * Selects options in a dropdown by their values (multi select).
+ * @param {string | Locator} input - The dropdown to select options in.
+ * @param {Array<string>} value - The values of the options to select.
+ * @param {SelectOptions} options - The select options.
+ */
+function selectByValues(input, value, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.selectOption(value, options);
+    });
+}
+exports.selectByValues = selectByValues;
+/**
+ * Selects an option in a dropdown by its text.
+ * @param {string | Locator} input - The dropdown to select an option in.
+ * @param {string} text - The text of the option to select.
+ * @param {SelectOptions} options - The select options.
+ */
+function selectByText(input, text, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.selectOption({ label: text }, options);
+    });
+}
+exports.selectByText = selectByText;
+/**
+ * Selects an option in a dropdown by its index.
+ * @param {string | Locator} input - The dropdown to select an option in.
+ * @param {number} index - The index of the option to select.
+ * @param {SelectOptions} options - The select options.
+ */
+function selectByIndex(input, index, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.selectOption({ index: index }, options);
+    });
+}
+exports.selectByIndex = selectByIndex;
+/**
+ * 3. Alerts: This section contains functions for handling alert dialogs.
+ * These functions include accepting and dismissing alerts, and getting the text of an alert.
+ * Note: These functions currently have some repetition and could be optimized by applying the DRY (Don't Repeat Yourself) principle.
+ */
+/**
+ * Accepts an alert dialog.
+ * @param {string | Locator} input - The element to click to trigger the alert.
+ * @param {string} promptText - The text to enter into a prompt dialog.
+ * @returns {Promise<string>} - The message of the dialog.
+ */
+function acceptAlert(input, promptText) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        let dialogMessage = '';
+        (0, page_utils_1.getPage)().once('dialog', dialog => {
+            dialogMessage = dialog.message();
+            dialog.accept(promptText).catch(e => console.error('Error accepting dialog:', e));
+        });
+        yield locator.click();
+        // temporary fix to alerts - Need to be fixed
+        // await getPage().waitForEvent('dialog');
+        return dialogMessage;
+    });
+}
+exports.acceptAlert = acceptAlert;
+/**
+ * Dismisses an alert dialog.
+ * @param {string | Locator} input - The element to click to trigger the alert.
+ * @returns {Promise<string>} - The message of the dialog.
+ */
+function dismissAlert(input) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        let dialogMessage = '';
+        (0, page_utils_1.getPage)().once('dialog', dialog => {
+            dialogMessage = dialog.message();
+            dialog.dismiss().catch(e => console.error('Error dismissing dialog:', e));
+        });
+        yield locator.click({ noWaitAfter: true });
+        // temporary fix for alerts - Need to be fixed
+        // await getPage().waitForEvent('dialog');
+        return dialogMessage;
+    });
+}
+exports.dismissAlert = dismissAlert;
+/**
+ * Gets the text of an alert dialog.
+ * @param {string | Locator} input - The element to click to trigger the alert.
+ * @returns {Promise<string>} - The message of the dialog.
+ */
+function getAlertText(input) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        let dialogMessage = '';
+        const dialogHandler = (dialog) => {
+            dialogMessage = dialog.message();
+        };
+        (0, page_utils_1.getPage)().once('dialog', dialogHandler);
+        yield locator.click();
+        yield (0, page_utils_1.getPage)().waitForEvent('dialog');
+        (0, page_utils_1.getPage)().off('dialog', dialogHandler);
+        return dialogMessage;
+    });
+}
+exports.getAlertText = getAlertText;
+/**
+ * Hovers over a specified element.
+ * @param {string | Locator} input - The element to hover over.
+ * @param {HoverOptions} options - The hover options.
+ */
+function hover(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.hover(options);
+    });
+}
+exports.hover = hover;
+/**
+ * Focuses on a specified element.
+ * @param {string | Locator} input - The element to focus on.
+ * @param {TimeoutOption} options - The timeout options.
+ */
+function focus(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.focus(options);
+    });
+}
+exports.focus = focus;
+/**
+ * Drags and drops a specified element to a destination.
+ * @param {string | Locator} input - The element to drag.
+ * @param {string | Locator} dest - The destination to drop the element at.
+ * @param {DragOptions} options - The drag options.
+ */
+function dragAndDrop(input, dest, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const drag = (0, locator_utils_1.getLocator)(input);
+        const drop = (0, locator_utils_1.getLocator)(dest);
+        yield drag.dragTo(drop, options);
+    });
+}
+exports.dragAndDrop = dragAndDrop;
+/**
+ * Double clicks on a specified element.
+ * @param {string | Locator} input - The element to double click on.
+ * @param {DoubleClickOptions} options - The double click options.
+ */
+function doubleClick(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.dblclick(options);
+    });
+}
+exports.doubleClick = doubleClick;
+/**
+ * Downloads a file from a specified element.
+ * @param {string | Locator} input - The element to download the file from.
+ * @param {string} path - The path to save the downloaded file to.
+ */
+function downloadFile(input, path) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        const downloadPromise = (0, page_utils_1.getPage)().waitForEvent('download');
+        yield click(locator);
+        const download = yield downloadPromise;
+        // Wait for the download process to complete
+        console.log(yield download.path());
+        // Save downloaded file somewhere
+        yield download.saveAs(path);
+    });
+}
+exports.downloadFile = downloadFile;
+/**
+ * Uploads files to a specified element.
+ * @param {string | Locator} input - The element to upload files to.
+ * @param {UploadValues} path - The files to upload.
+ * @param {UploadOptions} options - The upload options.
+ */
+function uploadFiles(input, path, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.setInputFiles(path, options);
+    });
+}
+exports.uploadFiles = uploadFiles;
+/**
+ * Scrolls a specified element into view.
+ * @param {string | Locator} input - The element to scroll into view.
+ * @param {TimeoutOption} options - The timeout options.
+ */
+function scrollLocatorIntoView(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.scrollIntoViewIfNeeded(options);
+    });
+}
+exports.scrollLocatorIntoView = scrollLocatorIntoView;
+/**
+ * 4. JS: This section contains functions that use JavaScript to interact with elements on a web page.
+ * These functions include clicking on an element using JavaScript.
+ */
+/**
+ * Clicks on a specified element using JavaScript.
+ * @param {string | Locator} input - The element to click on.
+ * @param {TimeoutOption} options - The timeout options.
+ */
+function clickByJS(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        yield locator.evaluate('el => el.click()', options);
+    });
+}
+exports.clickByJS = clickByJS;
+//# sourceMappingURL=action-utils.js.map

package/dist/vasu-playwright-lib/utils/action-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-utils.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/action-utils.ts"],"names":[],"mappings":";;;;AAKA,6CAAuC;AAkBvC,oDAAyD;AACzD,mDAA6C;AAC7C,sDAAmD;AAEnD;;;GAGG;AAEH;;;;;GAKG;AACH,SAAsB,OAAO,CAAC,IAAY,EAAE,UAAuB,EAAE,SAAS,EAAE,qBAAS,EAAE;;QACzF,OAAO,MAAM,IAAA,oBAAO,GAAE,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CAAA;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAsB,oBAAoB,CAAC,OAA2B;;QACpE,IAAI,SAAS,GAA4B,qBAAS,CAAC;QAEnD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KAAI,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE;YACxD,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;SAC/B;QAED,MAAM,IAAA,oBAAO,GAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;CAAA;AARD,oDAQC;AAED;;;GAGG;AACH,SAAsB,UAAU,CAAC,OAA2B;;QAC1D,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAA,oBAAO,GAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAA,oBAAO,GAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACzF,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CAAA;AAHD,gCAGC;AAED;;;GAGG;AACH,SAAsB,MAAM,CAAC,OAA2B;;QACtD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAA,oBAAO,GAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAA,oBAAO,GAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACzF,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CAAA;AAHD,wBAGC;AAED;;;GAGG;AACH,SAAsB,IAAI,CAAC,EAAU;;QACnC,0DAA0D;QAC1D,MAAM,IAAA,oBAAO,GAAE,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;CAAA;AAHD,oBAGC;AAED;;;GAGG;AAEH;;;;GAIG;AACH,SAAsB,KAAK,CAAC,KAAuB,EAAE,OAAsB;;QACzE,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAAA;AAHD,sBAGC;AAED;;;;GAIG;AACH,SAAsB,gBAAgB,CAAC,KAAuB,EAAE,OAAsB;;QACpF,MAAM,OAAO,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,2BAAgB,CAAC;QACrD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,IAAA,oBAAO,GAAE,CAAC,YAAY,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3G,MAAM,IAAA,oBAAO,GAAE,CAAC,gBAAgB,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KAAI,qBAAS,EAAE;YAChE,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;IACL,CAAC;CAAA;AAND,4CAMC;AAED;;;;;GAKG;AACH,SAAsB,IAAI,CAAC,KAAuB,EAAE,KAAa,EAAE,OAAqB;;QACtF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;CAAA;AAHD,oBAGC;AAED;;;;;GAKG;AACH,SAAsB,YAAY,CAAC,KAAuB,EAAE,KAAa,EAAE,OAAqB;;QAC9F,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAAA;AAJD,oCAIC;AAED;;;;;GAKG;AACH,SAAsB,IAAI,CAAC,KAAuB,EAAE,KAAa,EAAE,OAAqB;;QACtF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;CAAA;AAHD,oBAGC;AAED;;;;GAIG;AACH,SAAsB,KAAK,CAAC,KAAuB,EAAE,OAAsB;;QACzE,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAAA;AAHD,sBAGC;AAED;;;;GAIG;AACH,SAAsB,KAAK,CAAC,KAAuB,EAAE,OAAsB;;QACzE,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAAA;AAHD,sBAGC;AAED;;;;GAIG;AACH,SAAsB,OAAO,CAAC,KAAuB,EAAE,OAAsB;;QAC3E,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CAAA;AAHD,0BAGC;AAED;;;;;GAKG;AACH,SAAsB,aAAa,CAAC,KAAuB,EAAE,KAAa,EAAE,OAAuB;;QACjG,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CAAA;AAHD,sCAGC;AAED;;;;;GAKG;AACH,SAAsB,cAAc,CAClC,KAAuB,EACvB,KAAoB,EACpB,OAAuB;;QAEvB,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CAAA;AAPD,wCAOC;AAED;;;;;GAKG;AACH,SAAsB,YAAY,CAAC,KAAuB,EAAE,IAAY,EAAE,OAAuB;;QAC/F,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CAAA;AAHD,oCAGC;AAED;;;;;GAKG;AACH,SAAsB,aAAa,CAAC,KAAuB,EAAE,KAAa,EAAE,OAAuB;;QACjG,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CAAA;AAHD,sCAGC;AAED;;;;GAIG;AAEH;;;;;GAKG;AACH,SAAsB,WAAW,CAAC,KAAuB,EAAE,UAAmB;;QAC5E,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAA,oBAAO,GAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YAChC,aAAa,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,6CAA6C;QAC7C,0CAA0C;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;CAAA;AAXD,kCAWC;AAED;;;;GAIG;AACH,SAAsB,YAAY,CAAC,KAAuB;;QACxD,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAA,oBAAO,GAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YAChC,aAAa,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3C,8CAA8C;QAC9C,0CAA0C;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;CAAA;AAXD,oCAWC;AAED;;;;GAIG;AACH,SAAsB,YAAY,CAAC,KAAuB;;QACxD,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,EAAE;YACvC,aAAa,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QACnC,CAAC,CAAC;QACF,IAAA,oBAAO,GAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACxC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,IAAA,oBAAO,GAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAA,oBAAO,GAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACvC,OAAO,aAAa,CAAC;IACvB,CAAC;CAAA;AAXD,oCAWC;AAED;;;;GAIG;AACH,SAAsB,KAAK,CAAC,KAAuB,EAAE,OAAsB;;QACzE,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAAA;AAHD,sBAGC;AAED;;;;GAIG;AACH,SAAsB,KAAK,CAAC,KAAuB,EAAE,OAAuB;;QAC1E,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAAA;AAHD,sBAGC;AAED;;;;;GAKG;AACH,SAAsB,WAAW,CAC/B,KAAuB,EACvB,IAAsB,EACtB,OAAqB;;QAErB,MAAM,IAAI,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,IAAI,GAAG,IAAA,0BAAU,EAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;CAAA;AARD,kCAQC;AAED;;;;GAIG;AACH,SAAsB,WAAW,CAAC,KAAuB,EAAE,OAA4B;;QACrF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;CAAA;AAHD,kCAGC;AAED;;;;GAIG;AACH,SAAsB,YAAY,CAAC,KAAuB,EAAE,IAAY;;QACtE,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,eAAe,GAAG,IAAA,oBAAO,GAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;QACvC,4CAA4C;QAC5C,OAAO,CAAC,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACnC,iCAAiC;QACjC,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CAAA;AATD,oCASC;AAED;;;;;GAKG;AACH,SAAsB,WAAW,CAAC,KAAuB,EAAE,IAAkB,EAAE,OAAuB;;QACpG,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CAAA;AAHD,kCAGC;AAED;;;;GAIG;AACH,SAAsB,qBAAqB,CAAC,KAAuB,EAAE,OAAuB;;QAC1F,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;CAAA;AAHD,sDAGC;AAED;;;GAGG;AAEH;;;;GAIG;AACH,SAAsB,SAAS,CAAC,KAAuB,EAAE,OAAuB;;QAC9E,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAHD,8BAGC"}

package/dist/vasu-playwright-lib/utils/element-utils.d.ts

@@ -0,0 +1,100 @@
+/**
+ * element-utils.ts: This module provides utility functions for retrieving text from web elements in web page and conditional statements with in Playwright.
+ * These utilities include a variety of functions for retrieving text, input values, URLs, and checking conditions such as
+ * whether an element is visible or checked. It provides a layer of abstraction over Playwright's built-in methods for
+ * interacting with elements, making it easier to perform common tasks and checks on web elements.
+ */
+import { Locator } from 'playwright';
+import { NavigationOptions, TimeoutOption } from '../types/optional-parameter-types';
+/**
+ * 1. Retreiving Data: Use these functions to retrieve text, values, and counts from web elements.
+ * These functions can also be used in conditional statements to check the state of web elements.
+ * These functions are not intended for use in assertions, unless the built-in Playwright assertions do not meet your criteria.
+ */
+/**
+ * Returns the inner text of a Locator object.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<string>} - The inner text of the Locator.
+ */
+export declare function getText(input: string | Locator, options?: TimeoutOption): Promise<string>;
+/**
+ * Returns the inner text of all Locator objects.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @returns {Promise<Array<string>>} - The inner text of all Locator objects.
+ */
+export declare function getAllTexts(input: string | Locator): Promise<Array<string>>;
+/**
+ * Returns the input value of a Locator object.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<string>} - The input value of the Locator.
+ */
+export declare function getInputValue(input: string | Locator, options?: TimeoutOption): Promise<string>;
+/**
+ * Returns the input values of all Locator objects.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<Array<string>>} - The input values of all Locator objects.
+ */
+export declare function getAllInputValues(input: string | Locator, options?: TimeoutOption): Promise<Array<string>>;
+/**
+ * Returns the attribute of a Locator object.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {string} attributeName - The name of the attribute to get.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<null | string>} - The attribute of the Locator if present or null if absent.
+ */
+export declare function getAttribute(input: string | Locator, attributeName: string, options?: TimeoutOption): Promise<null | string>;
+/**
+ * Saves the storage state of the page.
+ * @param {string} [path] - Optional path to save the storage state to.
+ * @returns {Promise<void>}
+ */
+export declare function saveStorageState(path?: string): Promise<void>;
+/**
+ * Returns the URL of the page.
+ * @param {NavigationOptions} [options] - Optional navigation options.
+ * @returns {Promise<string>} - The URL of the page.
+ */
+export declare function getURL(options?: NavigationOptions): Promise<string>;
+/**
+ * Returns the count of Locator objects.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<number>} - The count of the Locator objects.
+ */
+export declare function getLocatorCount(input: string | Locator, options?: TimeoutOption): Promise<number>;
+/**
+ * 2. Conditions: Use these checks within conditional statements.
+ * They are not intended for use in assertions, unless the built-in Playwright assertions do not meet your criteria.
+ */
+/**
+ * Checks if a Locator object is attached to DOM.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<boolean>} - True if the Locator is attached, false otherwise.
+ */
+export declare function isElementAttached(input: string | Locator, options?: TimeoutOption): Promise<boolean>;
+/**
+ * Checks if a Locator object is attached to DOM and is visible.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<boolean>} - True if the Locator is visible, false otherwise.
+ */
+export declare function isElementVisible(input: string | Locator, options?: TimeoutOption): Promise<boolean>;
+/**
+ * Checks if a Locator object is hidden or not present in DOM.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<boolean>} - True if the Locator is hidden, false otherwise.
+ */
+export declare function isElementHidden(input: string | Locator, options?: TimeoutOption): Promise<boolean>;
+/**
+ * Checks if a Locator object is checked.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {TimeoutOption} [options] - Optional timeout options.
+ * @returns {Promise<boolean>} - True if the Locator is checked, false otherwise.
+ */
+export declare function isElementChecked(input: string | Locator, options?: TimeoutOption): Promise<boolean>;
+//# sourceMappingURL=element-utils.d.ts.map

package/dist/vasu-playwright-lib/utils/element-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-utils.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/element-utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAKrF;;;;GAIG;AAEH;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAG/F;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAGjF;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAGrG;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAGhH;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,KAAK,EAAE,MAAM,GAAG,OAAO,EACvB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAGxB;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnE;AAED;;;;GAIG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,iBAAyC,GAAG,OAAO,CAAC,MAAM,CAAC,CAQhG;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAUvG;AAED;;;GAGG;AAEH;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAW1G;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAezG;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAexG;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CASzG"}