vasu-playwright-utils 0.1.0

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

@@ -0,0 +1,232 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isElementChecked = exports.isElementHidden = exports.isElementVisible = exports.isElementAttached = exports.getLocatorCount = exports.getURL = exports.saveStorageState = exports.getAttribute = exports.getAllInputValues = exports.getInputValue = exports.getAllTexts = exports.getText = void 0;
+const tslib_1 = require("tslib");
+const page_utils_1 = require("./page-utils");
+const locator_utils_1 = require("./locator-utils");
+const timeouts_1 = require("../constants/timeouts");
+const action_utils_1 = require("./action-utils");
+/**
+ * 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.
+ */
+function getText(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        return yield locator.innerText(options);
+    });
+}
+exports.getText = getText;
+/**
+ * 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.
+ */
+function getAllTexts(input) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        return yield locator.allInnerTexts();
+    });
+}
+exports.getAllTexts = getAllTexts;
+/**
+ * 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.
+ */
+function getInputValue(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        return yield locator.inputValue(options);
+    });
+}
+exports.getInputValue = getInputValue;
+/**
+ * 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.
+ */
+function getAllInputValues(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locators = yield (0, locator_utils_1.getAllLocators)(input);
+        return Promise.all(locators.map(locator => getInputValue(locator, options)));
+    });
+}
+exports.getAllInputValues = getAllInputValues;
+/**
+ * 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.
+ */
+function getAttribute(input, attributeName, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        return yield locator.getAttribute(attributeName, options);
+    });
+}
+exports.getAttribute = getAttribute;
+/**
+ * Saves the storage state of the page.
+ * @param {string} [path] - Optional path to save the storage state to.
+ * @returns {Promise<void>}
+ */
+function saveStorageState(path) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield (0, page_utils_1.getPage)().context().storageState({ path: path });
+    });
+}
+exports.saveStorageState = saveStorageState;
+/**
+ * Returns the URL of the page.
+ * @param {NavigationOptions} [options] - Optional navigation options.
+ * @returns {Promise<string>} - The URL of the page.
+ */
+function getURL(options = { waitUntil: 'load' }) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        try {
+            yield (0, action_utils_1.waitForPageLoadState)(options);
+            return (0, page_utils_1.getPage)().url();
+        }
+        catch (error) {
+            console.log(`getURL- ${error instanceof Error ? error.message : String(error)}`);
+            return '';
+        }
+    });
+}
+exports.getURL = getURL;
+/**
+ * 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.
+ */
+function getLocatorCount(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const timeoutInMs = (options === null || options === void 0 ? void 0 : options.timeout) || timeouts_1.INSTANT_TIMEOUT;
+        try {
+            if (yield isElementAttached(input, { timeout: timeoutInMs })) {
+                return (yield (0, locator_utils_1.getAllLocators)(input)).length;
+            }
+        }
+        catch (error) {
+            console.log(`getLocatorCount- ${error instanceof Error ? error.message : String(error)}`);
+        }
+        return 0;
+    });
+}
+exports.getLocatorCount = getLocatorCount;
+/**
+ * 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.
+ */
+function isElementAttached(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input); // Assuming getLocator returns a Playwright Locator
+        const timeoutInMs = (options === null || options === void 0 ? void 0 : options.timeout) || timeouts_1.SMALL_TIMEOUT;
+        try {
+            yield locator.waitFor({ state: 'attached', timeout: timeoutInMs });
+            return true;
+        }
+        catch (error) {
+            console.log(`isElementAttached- ${error instanceof Error ? error.message : String(error)}`);
+            return false;
+        }
+    });
+}
+exports.isElementAttached = isElementAttached;
+/**
+ * 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.
+ */
+function isElementVisible(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        const timeoutInMs = (options === null || options === void 0 ? void 0 : options.timeout) || timeouts_1.SMALL_TIMEOUT;
+        const startTime = Date.now();
+        try {
+            while (Date.now() - startTime < timeoutInMs) {
+                if (yield locator.isVisible(options)) {
+                    return true;
+                }
+                yield new Promise(resolve => setTimeout(resolve, 100));
+            }
+        }
+        catch (error) {
+            console.log(`isElementVisible- ${error instanceof Error ? error.message : String(error)}`);
+        }
+        return false;
+    });
+}
+exports.isElementVisible = isElementVisible;
+/**
+ * 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.
+ */
+function isElementHidden(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const locator = (0, locator_utils_1.getLocator)(input);
+        const timeoutInMs = (options === null || options === void 0 ? void 0 : options.timeout) || timeouts_1.SMALL_TIMEOUT;
+        const startTime = Date.now();
+        try {
+            while (Date.now() - startTime < timeoutInMs) {
+                if (yield locator.isHidden(options)) {
+                    return true;
+                }
+                yield new Promise(resolve => setTimeout(resolve, 100));
+            }
+        }
+        catch (error) {
+            console.log(`isElementHidden- ${error instanceof Error ? error.message : String(error)}`);
+        }
+        return false;
+    });
+}
+exports.isElementHidden = isElementHidden;
+/**
+ * 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.
+ */
+function isElementChecked(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        try {
+            if (yield isElementVisible(input, options)) {
+                return yield (0, locator_utils_1.getLocator)(input).isChecked(options);
+            }
+        }
+        catch (error) {
+            console.log(`isElementChecked- ${error instanceof Error ? error.message : String(error)}`);
+        }
+        return false;
+    });
+}
+exports.isElementChecked = isElementChecked;
+//# sourceMappingURL=element-utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"element-utils.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/element-utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAGH,6CAAuC;AAEvC,mDAA6D;AAC7D,oDAAuE;AACvE,iDAAsD;AAEtD;;;;GAIG;AAEH;;;;;GAKG;AACH,SAAsB,OAAO,CAAC,KAAuB,EAAE,OAAuB;;QAC5E,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,OAAO,MAAM,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;CAAA;AAHD,0BAGC;AAED;;;;GAIG;AACH,SAAsB,WAAW,CAAC,KAAuB;;QACvD,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,OAAO,MAAM,OAAO,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;CAAA;AAHD,kCAGC;AAED;;;;;GAKG;AACH,SAAsB,aAAa,CAAC,KAAuB,EAAE,OAAuB;;QAClF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,OAAO,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;CAAA;AAHD,sCAGC;AAED;;;;;GAKG;AACH,SAAsB,iBAAiB,CAAC,KAAuB,EAAE,OAAuB;;QACtF,MAAM,QAAQ,GAAG,MAAM,IAAA,8BAAc,EAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/E,CAAC;CAAA;AAHD,8CAGC;AAED;;;;;;GAMG;AACH,SAAsB,YAAY,CAChC,KAAuB,EACvB,aAAqB,EACrB,OAAuB;;QAEvB,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,OAAO,MAAM,OAAO,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;CAAA;AAPD,oCAOC;AAED;;;;GAIG;AACH,SAAsB,gBAAgB,CAAC,IAAa;;QAClD,MAAM,IAAA,oBAAO,GAAE,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;CAAA;AAFD,4CAEC;AAED;;;;GAIG;AACH,SAAsB,MAAM,CAAC,UAA6B,EAAE,SAAS,EAAE,MAAM,EAAE;;QAC7E,IAAI;YACF,MAAM,IAAA,mCAAoB,EAAC,OAAO,CAAC,CAAC;YACpC,OAAO,IAAA,oBAAO,GAAE,CAAC,GAAG,EAAE,CAAC;SACxB;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACjF,OAAO,EAAE,CAAC;SACX;IACH,CAAC;CAAA;AARD,wBAQC;AAED;;;;;GAKG;AACH,SAAsB,eAAe,CAAC,KAAuB,EAAE,OAAuB;;QACpF,MAAM,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,0BAAe,CAAC;QACxD,IAAI;YACF,IAAI,MAAM,iBAAiB,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,EAAE;gBAC5D,OAAO,CAAC,MAAM,IAAA,8BAAc,EAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;aAC7C;SACF;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SAC3F;QACD,OAAO,CAAC,CAAC;IACX,CAAC;CAAA;AAVD,0CAUC;AAED;;;GAGG;AAEH;;;;;GAKG;AACH,SAAsB,iBAAiB,CAAC,KAAuB,EAAE,OAAuB;;QACtF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC,CAAC,mDAAmD;QACtF,MAAM,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,wBAAa,CAAC;QAEtD,IAAI;YACF,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;YACnE,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC5F,OAAO,KAAK,CAAC;SACd;IACH,CAAC;CAAA;AAXD,8CAWC;AAED;;;;;GAKG;AACH,SAAsB,gBAAgB,CAAC,KAAuB,EAAE,OAAuB;;QACrF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,wBAAa,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI;YACF,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,WAAW,EAAE;gBAC3C,IAAI,MAAM,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;oBACpC,OAAO,IAAI,CAAC;iBACb;gBACD,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;aACxD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,qBAAqB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SAC5F;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CAAA;AAfD,4CAeC;AAED;;;;;GAKG;AACH,SAAsB,eAAe,CAAC,KAAuB,EAAE,OAAuB;;QACpF,MAAM,OAAO,GAAG,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC;QAClC,MAAM,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,wBAAa,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI;YACF,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,WAAW,EAAE;gBAC3C,IAAI,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;oBACnC,OAAO,IAAI,CAAC;iBACb;gBACD,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;aACxD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SAC3F;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CAAA;AAfD,0CAeC;AAED;;;;;GAKG;AACH,SAAsB,gBAAgB,CAAC,KAAuB,EAAE,OAAuB;;QACrF,IAAI;YACF,IAAI,MAAM,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE;gBAC1C,OAAO,MAAM,IAAA,0BAAU,EAAC,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;aACnD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,qBAAqB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SAC5F;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CAAA;AATD,4CASC"}

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

@@ -0,0 +1,5 @@
+export * from './action-utils';
+export * from './element-utils';
+export * from './locator-utils';
+export * from './page-utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/index.ts"],"names":[],"mappings":"AAGA,cAAc,gBAAgB,CAAC;AAG/B,cAAc,iBAAiB,CAAC;AAGhC,cAAc,iBAAiB,CAAC;AAGhC,cAAc,cAAc,CAAC"}

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

@@ -0,0 +1,13 @@
+"use strict";
+// utils/index.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// Export everything from ActionUtils.ts
+tslib_1.__exportStar(require("./action-utils"), exports);
+// Export everything from ElementUtils.ts
+tslib_1.__exportStar(require("./element-utils"), exports);
+// Export everything from LocatorUtils.ts
+tslib_1.__exportStar(require("./locator-utils"), exports);
+// Export everything from PageUtils.ts
+tslib_1.__exportStar(require("./page-utils"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/index.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAEjB,wCAAwC;AACxC,yDAA+B;AAE/B,yCAAyC;AACzC,0DAAgC;AAEhC,yCAAyC;AACzC,0DAAgC;AAEhC,sCAAsC;AACtC,uDAA6B"}

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

@@ -0,0 +1,77 @@
+/**
+ * locator-utils.ts: This module provides utility functions for handling and manipulating locators in Playwright.
+ * These utilities make it easier to interact with elements on the page, providing a layer of abstraction over Playwright's built-in locator methods.
+ */
+import { FrameLocator, Locator } from 'playwright';
+import { GetByPlaceholderOptions, GetByRoleOptions, GetByRoleTypes, GetByTextOptions, LocatorOptions } from '../types/optional-parameter-types';
+/**
+ * 1. Locators: This section contains functions and definitions related to locators.
+ * Locators are used to find and interact with elements on the page.
+ */
+/**
+ * Returns a Locator object based on the input provided.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {LocatorOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocator(input: string | Locator, options?: LocatorOptions): Locator;
+/**
+ * Returns a Locator object with a specific testId. The global testId attribute is set in the playwright.config.ts file with default value as 'data-testid' if not set explicitly, but can be overridden by providing an attributeName.
+ * @param {string | RegExp} testId - The testId to create the Locator from.
+ * @param {string} [attributeName] - Optional attribute name for the testId. If provided, this will override the default 'testId' attribute value set in the playwright.config.ts file only for this instance.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocatorByTestId(testId: string | RegExp, attributeName?: string): Locator;
+/**
+ * Returns a Locator object with a specific text.
+ * @param {string | RegExp} text - The text to create the Locator from.
+ * @param {GetByTextOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocatorByText(text: string | RegExp, options?: GetByTextOptions): Locator;
+/**
+ * Returns a Locator object with a specific role.
+ * @param {GetByRoleTypes} role - The role to create the Locator from.
+ * @param {GetByRoleOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocatorByRole(role: GetByRoleTypes, options?: GetByRoleOptions): Locator;
+/**
+ * Returns a Locator object with a specific label.
+ * @param {string | RegExp} text - The label text to create the Locator from.
+ * @param {GetByRoleOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocatorByLabel(text: string | RegExp, options?: GetByRoleOptions): Locator;
+/**
+ * Returns a Locator object with a specific placeholder.
+ * @param {string | RegExp} text - The place holder text to create the Locator from.
+ * @param {GetByPlaceholderOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocatorByPlaceholder(text: string | RegExp, options?: GetByPlaceholderOptions): Locator;
+/**
+ * Returns all Locator objects based on the input provided.
+ * @param {string | Locator} input - The input to create the Locators from.
+ * @param {LocatorOptions} options - Optional parameters for the Locators.
+ * @returns {Promise<Locator[]>} - The created Locator objects.
+ */
+export declare function getAllLocators(input: string | Locator, options?: LocatorOptions): Promise<Locator[]>;
+/**
+ * 2. Frames: This section contains functions and definitions related to frames.
+ * Frames are used to handle and interact with iframes or frames within the web page.
+ */
+/**
+ * Returns a FrameLocator object based on the input provided.
+ * @param {string | FrameLocator} frameInput - The input to create the FrameLocator from.
+ * @returns {FrameLocator} - The created FrameLocator object.
+ */
+export declare function getFrameLocator(frameInput: string | FrameLocator): FrameLocator;
+/**
+ * Returns a Locator object within a specific frame based on the input provided.
+ * @param {string | FrameLocator} frameInput - The input to create the FrameLocator from.
+ * @param {string | Locator} input - The input to create the Locator from, within the frame.
+ * @returns {Locator} - The created Locator object.
+ */
+export declare function getLocatorInFrame(frameInput: string | FrameLocator, input: string | Locator): Locator;
+//# sourceMappingURL=locator-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"locator-utils.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/locator-utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,OAAO,EAAa,MAAM,YAAY,CAAC;AAE9D,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,cAAc,EACf,MAAM,mCAAmC,CAAC;AAE3C;;;GAGG;AAEH;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAErF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAK3F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAE3F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAE1F;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAE5F;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAEzG;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAE1G;AAED;;;GAGG;AAEH;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,GAAG,YAAY,CAE/E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAErG"}

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

@@ -0,0 +1,113 @@
+"use strict";
+/**
+ * locator-utils.ts: This module provides utility functions for handling and manipulating locators in Playwright.
+ * These utilities make it easier to interact with elements on the page, providing a layer of abstraction over Playwright's built-in locator methods.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLocatorInFrame = exports.getFrameLocator = exports.getAllLocators = exports.getLocatorByPlaceholder = exports.getLocatorByLabel = exports.getLocatorByRole = exports.getLocatorByText = exports.getLocatorByTestId = exports.getLocator = void 0;
+const tslib_1 = require("tslib");
+const playwright_1 = require("playwright");
+const page_utils_1 = require("./page-utils");
+/**
+ * 1. Locators: This section contains functions and definitions related to locators.
+ * Locators are used to find and interact with elements on the page.
+ */
+/**
+ * Returns a Locator object based on the input provided.
+ * @param {string | Locator} input - The input to create the Locator from.
+ * @param {LocatorOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocator(input, options) {
+    return typeof input === 'string' ? (0, page_utils_1.getPage)().locator(input, options) : input;
+}
+exports.getLocator = getLocator;
+/**
+ * Returns a Locator object with a specific testId. The global testId attribute is set in the playwright.config.ts file with default value as 'data-testid' if not set explicitly, but can be overridden by providing an attributeName.
+ * @param {string | RegExp} testId - The testId to create the Locator from.
+ * @param {string} [attributeName] - Optional attribute name for the testId. If provided, this will override the default 'testId' attribute value set in the playwright.config.ts file only for this instance.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocatorByTestId(testId, attributeName) {
+    if (attributeName) {
+        playwright_1.selectors.setTestIdAttribute(attributeName);
+    }
+    return (0, page_utils_1.getPage)().getByTestId(testId);
+}
+exports.getLocatorByTestId = getLocatorByTestId;
+/**
+ * Returns a Locator object with a specific text.
+ * @param {string | RegExp} text - The text to create the Locator from.
+ * @param {GetByTextOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocatorByText(text, options) {
+    return (0, page_utils_1.getPage)().getByText(text, options);
+}
+exports.getLocatorByText = getLocatorByText;
+/**
+ * Returns a Locator object with a specific role.
+ * @param {GetByRoleTypes} role - The role to create the Locator from.
+ * @param {GetByRoleOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocatorByRole(role, options) {
+    return (0, page_utils_1.getPage)().getByRole(role, options);
+}
+exports.getLocatorByRole = getLocatorByRole;
+/**
+ * Returns a Locator object with a specific label.
+ * @param {string | RegExp} text - The label text to create the Locator from.
+ * @param {GetByRoleOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocatorByLabel(text, options) {
+    return (0, page_utils_1.getPage)().getByLabel(text, options);
+}
+exports.getLocatorByLabel = getLocatorByLabel;
+/**
+ * Returns a Locator object with a specific placeholder.
+ * @param {string | RegExp} text - The place holder text to create the Locator from.
+ * @param {GetByPlaceholderOptions} options - Optional parameters for the Locator.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocatorByPlaceholder(text, options) {
+    return (0, page_utils_1.getPage)().getByPlaceholder(text, options);
+}
+exports.getLocatorByPlaceholder = getLocatorByPlaceholder;
+/**
+ * Returns all Locator objects based on the input provided.
+ * @param {string | Locator} input - The input to create the Locators from.
+ * @param {LocatorOptions} options - Optional parameters for the Locators.
+ * @returns {Promise<Locator[]>} - The created Locator objects.
+ */
+function getAllLocators(input, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return typeof input === 'string' ? yield (0, page_utils_1.getPage)().locator(input, options).all() : yield input.all();
+    });
+}
+exports.getAllLocators = getAllLocators;
+/**
+ * 2. Frames: This section contains functions and definitions related to frames.
+ * Frames are used to handle and interact with iframes or frames within the web page.
+ */
+/**
+ * Returns a FrameLocator object based on the input provided.
+ * @param {string | FrameLocator} frameInput - The input to create the FrameLocator from.
+ * @returns {FrameLocator} - The created FrameLocator object.
+ */
+function getFrameLocator(frameInput) {
+    return typeof frameInput === 'string' ? (0, page_utils_1.getPage)().frameLocator(frameInput) : frameInput;
+}
+exports.getFrameLocator = getFrameLocator;
+/**
+ * Returns a Locator object within a specific frame based on the input provided.
+ * @param {string | FrameLocator} frameInput - The input to create the FrameLocator from.
+ * @param {string | Locator} input - The input to create the Locator from, within the frame.
+ * @returns {Locator} - The created Locator object.
+ */
+function getLocatorInFrame(frameInput, input) {
+    return getFrameLocator(frameInput).locator(input);
+}
+exports.getLocatorInFrame = getLocatorInFrame;
+//# sourceMappingURL=locator-utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"locator-utils.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/locator-utils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,2CAA8D;AAC9D,6CAAuC;AASvC;;;GAGG;AAEH;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAuB,EAAE,OAAwB;IAC1E,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,oBAAO,GAAE,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC/E,CAAC;AAFD,gCAEC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,MAAuB,EAAE,aAAsB;IAChF,IAAI,aAAa,EAAE;QACjB,sBAAS,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;KAC7C;IACD,OAAO,IAAA,oBAAO,GAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AALD,gDAKC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,IAAqB,EAAE,OAA0B;IAChF,OAAO,IAAA,oBAAO,GAAE,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAFD,4CAEC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,IAAoB,EAAE,OAA0B;IAC/E,OAAO,IAAA,oBAAO,GAAE,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAFD,4CAEC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,IAAqB,EAAE,OAA0B;IACjF,OAAO,IAAA,oBAAO,GAAE,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC;AAFD,8CAEC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,IAAqB,EAAE,OAAiC;IAC9F,OAAO,IAAA,oBAAO,GAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC;AAFD,0DAEC;AAED;;;;;GAKG;AACH,SAAsB,cAAc,CAAC,KAAuB,EAAE,OAAwB;;QACpF,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAA,oBAAO,GAAE,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;IACvG,CAAC;CAAA;AAFD,wCAEC;AAED;;;GAGG;AAEH;;;;GAIG;AACH,SAAgB,eAAe,CAAC,UAAiC;IAC/D,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,oBAAO,GAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;AAC1F,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,UAAiC,EAAE,KAAuB;IAC1F,OAAO,eAAe,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC;AAFD,8CAEC"}

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

@@ -0,0 +1,36 @@
+/**
+ * page-factory.ts: This module is responsible for setting and managing instances of pages.
+ * It provides a centralized way to set and access pages, ensuring that each test has a clean, isolated page instance.
+ * This helps to maintain the state and context of each test independently, improving test reliability and debugging.
+ * It also includes functions for switching between pages, closing pages, and reverting to the default page.
+ */
+import { Page } from 'playwright';
+/**
+ * Returns the current Page.
+ * @returns {Page} The current Page.
+ */
+export declare function getPage(): Page;
+/**
+ * Sets the current Page.
+ * @param {Page} pageInstance - The Page instance to set as the current Page.
+ */
+export declare function setPage(pageInstance: Page): void;
+/**
+ * Switches to a different page by its index (1-based).
+ * If the desired page isn't immediately available, this function will wait and retry for up to 'SMALL_TIMEOUT' seconds.
+ * @param {number} winNum - The index of the page to switch to.
+ * @throws {Error} If the desired page isn't found within 'SMALL_TIMEOUT' seconds.
+ */
+export declare function switchPage(winNum: number): Promise<void>;
+/**
+ * Switches back to the default page (the first one).
+ */
+export declare function switchToDefaultPage(): Promise<void>;
+/**
+ * Closes a page by its index (1-based).
+ * If no index is provided, the current page is closed.
+ * If there are other pages open, it will switch back to the default page.
+ * @param {number} winNum - The index of the page to close.
+ */
+export declare function closePage(winNum: number): Promise<void>;
+//# sourceMappingURL=page-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"page-utils.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/page-utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIlC;;;GAGG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,YAAY,EAAE,IAAI,GAAG,IAAI,CAEhD;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAW9D;AAED;;GAEG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAMzD;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAW7D"}

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

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * page-factory.ts: This module is responsible for setting and managing instances of pages.
+ * It provides a centralized way to set and access pages, ensuring that each test has a clean, isolated page instance.
+ * This helps to maintain the state and context of each test independently, improving test reliability and debugging.
+ * It also includes functions for switching between pages, closing pages, and reverting to the default page.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.closePage = exports.switchToDefaultPage = exports.switchPage = exports.setPage = exports.getPage = void 0;
+const tslib_1 = require("tslib");
+const timeouts_1 = require("../constants/timeouts");
+let page;
+/**
+ * Returns the current Page.
+ * @returns {Page} The current Page.
+ */
+function getPage() {
+    return page;
+}
+exports.getPage = getPage;
+/**
+ * Sets the current Page.
+ * @param {Page} pageInstance - The Page instance to set as the current Page.
+ */
+function setPage(pageInstance) {
+    page = pageInstance;
+}
+exports.setPage = setPage;
+/**
+ * Switches to a different page by its index (1-based).
+ * If the desired page isn't immediately available, this function will wait and retry for up to 'SMALL_TIMEOUT' seconds.
+ * @param {number} winNum - The index of the page to switch to.
+ * @throws {Error} If the desired page isn't found within 'SMALL_TIMEOUT' seconds.
+ */
+function switchPage(winNum) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const startTime = Date.now();
+        while (page.context().pages().length < winNum && Date.now() - startTime < timeouts_1.SMALL_TIMEOUT) {
+            yield new Promise(resolve => setTimeout(resolve, 100));
+        }
+        if (page.context().pages().length < winNum) {
+            throw new Error(`Page number ${winNum} not found after ${timeouts_1.SMALL_TIMEOUT} seconds`);
+        }
+        const pageInstance = page.context().pages()[winNum - 1];
+        yield pageInstance.waitForLoadState();
+        setPage(pageInstance);
+    });
+}
+exports.switchPage = switchPage;
+/**
+ * Switches back to the default page (the first one).
+ */
+function switchToDefaultPage() {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const pageInstance = page.context().pages()[0];
+        if (pageInstance) {
+            yield pageInstance.bringToFront();
+            setPage(pageInstance);
+        }
+    });
+}
+exports.switchToDefaultPage = switchToDefaultPage;
+/**
+ * Closes a page by its index (1-based).
+ * If no index is provided, the current page is closed.
+ * If there are other pages open, it will switch back to the default page.
+ * @param {number} winNum - The index of the page to close.
+ */
+function closePage(winNum) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (!winNum) {
+            yield page.close();
+            return;
+        }
+        const noOfWindows = page.context().pages().length;
+        const pageInstance = page.context().pages()[winNum - 1];
+        yield pageInstance.close();
+        if (noOfWindows > 1) {
+            yield switchToDefaultPage();
+        }
+    });
+}
+exports.closePage = closePage;
+//# sourceMappingURL=page-utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"page-utils.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/page-utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,oDAAsD;AAGtD,IAAI,IAAU,CAAC;AAEf;;;GAGG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAI,CAAC;AACd,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,YAAkB;IACxC,IAAI,GAAG,YAAY,CAAC;AACtB,CAAC;AAFD,0BAEC;AAED;;;;;GAKG;AACH,SAAsB,UAAU,CAAC,MAAc;;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,wBAAa,EAAE;YACvF,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;SACxD;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,MAAM,GAAG,MAAM,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,eAAe,MAAM,oBAAoB,wBAAa,UAAU,CAAC,CAAC;SACnF;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,MAAM,YAAY,CAAC,gBAAgB,EAAE,CAAC;QACtC,OAAO,CAAC,YAAY,CAAC,CAAC;IACxB,CAAC;CAAA;AAXD,gCAWC;AAED;;GAEG;AACH,SAAsB,mBAAmB;;QACvC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAI,YAAY,EAAE;YAChB,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;YAClC,OAAO,CAAC,YAAY,CAAC,CAAC;SACvB;IACH,CAAC;CAAA;AAND,kDAMC;AAED;;;;;GAKG;AACH,SAAsB,SAAS,CAAC,MAAc;;QAC5C,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO;SACR;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC;QAClD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,WAAW,GAAG,CAAC,EAAE;YACnB,MAAM,mBAAmB,EAAE,CAAC;SAC7B;IACH,CAAC;CAAA;AAXD,8BAWC"}