vasu-playwright-utils 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Vasudeva Chowdary Annam]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# Playwright TypeScript Utility Functions Library
+
+[![GitHub stars](https://img.shields.io/github/stars/vasu31dev/playwright-ts-lib)](https://github.com/vasu31dev/playwright-ts-lib/stargazers)
+![Last Commit](https://img.shields.io/github/last-commit/vasu31dev/playwright-ts-lib) ![Pull Requests](https://img.shields.io/github/issues-pr-raw/vasu31dev/playwright-ts-lib)
+
+## About
+
+`playwright-ts-lib` is a TypeScript library that provides reusable helper methods for the Playwright Library. It aims to simplify common tasks and enhance the efficiency of automated testing workflows.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Installation
+
+To install the library, run the following command:
+
+```bash
+npm install vasu-playwright-utils
+```
+
+## Usage
+
+Here's a simple example of how you can use the library:
+
+```typescript
+import { LOADSTATE } from 'vasu-playwright-utils';
+
+// Your code here
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Support and Feedback
+
+If you encounter any issues or have feedback, please [create an issue](https://github.com/vasu31dev/playwright-ts-lib/issues) on GitHub.

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

@@ -0,0 +1,3 @@
+export * from './loadstate';
+export * from './timeouts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/constants/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./loadstate"), exports);
+tslib_1.__exportStar(require("./timeouts"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/constants/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,qDAA2B"}

package/dist/vasu-playwright-lib/constants/loadstate.d.ts

@@ -0,0 +1,17 @@
+/**
+ * loadstate.ts
+ * This module provides the LOADSTATE constant that can be used to override the initial page load state and navigation load state auto waits.
+ * The LOADSTATE is used as default value in the gotoURL, waitForPageLoadState, and clickAndNavigate helper functions.
+ * Instead of hardcoding the LOADSTATE, initialize it here with a value that can be used for the entire project, and override in functions as necessary based on the need.
+ * @module loadstate
+ */
+import { WaitForLoadStateOptions } from '../types/optional-parameter-types';
+/**
+ * Represents the load state option for waiting for specific events during page navigation.
+ * This constant is utilized in the gotoURL, waitForPageLoadState, and clickAndNavigate helper functions.
+ * @type {WaitForLoadStateOptions}
+ * @const
+ * @default 'domcontentloaded'
+ */
+export declare const LOADSTATE: WaitForLoadStateOptions;
+//# sourceMappingURL=loadstate.d.ts.map

package/dist/vasu-playwright-lib/constants/loadstate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadstate.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/constants/loadstate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAE5E;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,uBAA4C,CAAC"}

package/dist/vasu-playwright-lib/constants/loadstate.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * loadstate.ts
+ * This module provides the LOADSTATE constant that can be used to override the initial page load state and navigation load state auto waits.
+ * The LOADSTATE is used as default value in the gotoURL, waitForPageLoadState, and clickAndNavigate helper functions.
+ * Instead of hardcoding the LOADSTATE, initialize it here with a value that can be used for the entire project, and override in functions as necessary based on the need.
+ * @module loadstate
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOADSTATE = void 0;
+/**
+ * Represents the load state option for waiting for specific events during page navigation.
+ * This constant is utilized in the gotoURL, waitForPageLoadState, and clickAndNavigate helper functions.
+ * @type {WaitForLoadStateOptions}
+ * @const
+ * @default 'domcontentloaded'
+ */
+exports.LOADSTATE = 'domcontentloaded';
+//# sourceMappingURL=loadstate.js.map

package/dist/vasu-playwright-lib/constants/loadstate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadstate.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/constants/loadstate.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAIH;;;;;;GAMG;AACU,QAAA,SAAS,GAA4B,kBAAkB,CAAC"}

package/dist/vasu-playwright-lib/constants/timeouts.d.ts

@@ -0,0 +1,44 @@
+/**
+ * timeouts.ts: This module provides Timeout constants that can be used to override various actions, conditional statements and assertions.
+ * Instead of hard coding the timeout when overriding any utility functions, use these Timeout constants.
+ */
+/**
+ * Timeout constant for instant actions/assertions, set to 1000 milliseconds (1 second).
+ */
+export declare const INSTANT_TIMEOUT = 1000;
+/**
+ * Timeout constant for small actions/assertions, set to 5000 milliseconds (5 seconds).
+ */
+export declare const SMALL_TIMEOUT: number;
+/**
+ * Standard timeout constant, set to 15000 milliseconds (15 seconds).
+ */
+export declare const STANDARD_TIMEOUT: number;
+/**
+ * Timeout constant for bigger actions/assertions, set to 30000 milliseconds (30 seconds).
+ */
+export declare const BIG_TIMEOUT: number;
+/**
+ * Maximum timeout constant, set to 60000 milliseconds (1 minute).
+ */
+export declare const MAX_TIMEOUT: number;
+/**
+ * Timeout constants used in the playwright.config.ts file.
+ */
+/**
+ * Timeout constant for Playwright's expect function, set to 5000 milliseconds (5 seconds).
+ */
+export declare const EXPECT_TIMEOUT: number;
+/**
+ * Timeout constant for Playwright's action functions, set to 5000 milliseconds (5 seconds).
+ */
+export declare const ACTION_TIMEOUT: number;
+/**
+ * Timeout constant for Playwright's navigation functions, set to 30000 milliseconds (30 seconds).
+ */
+export declare const NAVIGATION_TIMEOUT: number;
+/**
+ * Timeout constant for Playwright's test functions, set to 120000 milliseconds (2 minutes).
+ */
+export declare const TEST_TIMEOUT: number;
+//# sourceMappingURL=timeouts.d.ts.map

package/dist/vasu-playwright-lib/constants/timeouts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeouts.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/constants/timeouts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,eAAO,MAAM,eAAe,OAAO,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,aAAa,QAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAY,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,WAAW,QAAY,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,WAAW,QAAY,CAAC;AAErC;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,cAAc,QAAW,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,cAAc,QAAW,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,QAAY,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,YAAY,QAAgB,CAAC"}

package/dist/vasu-playwright-lib/constants/timeouts.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * timeouts.ts: This module provides Timeout constants that can be used to override various actions, conditional statements and assertions.
+ * Instead of hard coding the timeout when overriding any utility functions, use these Timeout constants.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TEST_TIMEOUT = exports.NAVIGATION_TIMEOUT = exports.ACTION_TIMEOUT = exports.EXPECT_TIMEOUT = exports.MAX_TIMEOUT = exports.BIG_TIMEOUT = exports.STANDARD_TIMEOUT = exports.SMALL_TIMEOUT = exports.INSTANT_TIMEOUT = void 0;
+/**
+ * Timeout constant for instant actions/assertions, set to 1000 milliseconds (1 second).
+ */
+exports.INSTANT_TIMEOUT = 1000;
+/**
+ * Timeout constant for small actions/assertions, set to 5000 milliseconds (5 seconds).
+ */
+exports.SMALL_TIMEOUT = 5 * 1000;
+/**
+ * Standard timeout constant, set to 15000 milliseconds (15 seconds).
+ */
+exports.STANDARD_TIMEOUT = 15 * 1000;
+/**
+ * Timeout constant for bigger actions/assertions, set to 30000 milliseconds (30 seconds).
+ */
+exports.BIG_TIMEOUT = 30 * 1000;
+/**
+ * Maximum timeout constant, set to 60000 milliseconds (1 minute).
+ */
+exports.MAX_TIMEOUT = 60 * 1000;
+/**
+ * Timeout constants used in the playwright.config.ts file.
+ */
+/**
+ * Timeout constant for Playwright's expect function, set to 5000 milliseconds (5 seconds).
+ */
+exports.EXPECT_TIMEOUT = 5 * 1000;
+/**
+ * Timeout constant for Playwright's action functions, set to 5000 milliseconds (5 seconds).
+ */
+exports.ACTION_TIMEOUT = 5 * 1000;
+/**
+ * Timeout constant for Playwright's navigation functions, set to 30000 milliseconds (30 seconds).
+ */
+exports.NAVIGATION_TIMEOUT = 30 * 1000;
+/**
+ * Timeout constant for Playwright's test functions, set to 120000 milliseconds (2 minutes).
+ */
+exports.TEST_TIMEOUT = 2 * 60 * 1000;
+//# sourceMappingURL=timeouts.js.map

package/dist/vasu-playwright-lib/constants/timeouts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeouts.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/constants/timeouts.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACU,QAAA,eAAe,GAAG,IAAI,CAAC;AAEpC;;GAEG;AACU,QAAA,aAAa,GAAG,CAAC,GAAG,IAAI,CAAC;AAEtC;;GAEG;AACU,QAAA,gBAAgB,GAAG,EAAE,GAAG,IAAI,CAAC;AAE1C;;GAEG;AACU,QAAA,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC;AAErC;;GAEG;AACU,QAAA,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC;AAErC;;GAEG;AAEH;;GAEG;AACU,QAAA,cAAc,GAAG,CAAC,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,cAAc,GAAG,CAAC,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,EAAE,GAAG,IAAI,CAAC;AAE5C;;GAEG;AACU,QAAA,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC"}

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

@@ -0,0 +1,4 @@
+export * from './utils';
+export * from './constants';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vasu-playwright-lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC"}

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./utils"), exports);
+tslib_1.__exportStar(require("./constants"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/vasu-playwright-lib/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,sDAA4B;AAC5B,kDAAwB"}

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

@@ -0,0 +1,2 @@
+export * from './optional-parameter-types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC"}

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./optional-parameter-types"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/types/index.ts"],"names":[],"mappings":";;;AAAA,qEAA2C"}

package/dist/vasu-playwright-lib/types/optional-parameter-types.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Types.ts: This module provides type definitions that are used as optional parameters for utility functions in other modules.
+ * These types are based on the parameters of Playwright's built-in methods and are used to provide type safety and code completion.
+ */
+import { Locator, Page } from 'playwright';
+/**
+ * 1. Navigation Options: These types are used for navigation actions such as going to a URL, reloading a page, or waiting for a certain load state.
+ * They are based on the parameters of Playwright's built-in navigation methods.
+ */
+export type GotoOptions = Parameters<Page['goto']>[1];
+export type NavigationOptions = Parameters<Page['reload']>[0];
+export type WaitForLoadStateOptions = Parameters<Page['waitForLoadState']>[0];
+/**
+ * 2. Action Options: These types are used for actions such as clicking, filling input fields, typing, etc.
+ * They are based on the parameters of Playwright's built-in action methods.
+ */
+export type ClickOptions = Parameters<Locator['click']>[0] & {
+    loadState?: WaitForLoadStateOptions;
+};
+export type FillOptions = Parameters<Locator['fill']>[1];
+export type TypeOptions = Parameters<Locator['type']>[1];
+export type ClearOptions = Parameters<Locator['clear']>[0];
+export type SelectValues = Parameters<Locator['selectOption']>[0];
+export type SelectOptions = Parameters<Locator['selectOption']>[1];
+export type CheckOptions = Parameters<Locator['check']>[0];
+export type HoverOptions = Parameters<Locator['hover']>[0];
+export type UploadValues = Parameters<Locator['setInputFiles']>[0];
+export type UploadOptions = Parameters<Locator['setInputFiles']>[1];
+export type DragOptions = Parameters<Locator['dragTo']>[1];
+export type DoubleClickOptions = Parameters<Locator['dblclick']>[0];
+/**
+ * 3. Expect Options: These types are used for assertions, Timeouts, etc in tests.
+ * They are based on the parameters of Playwright's built-in expect methods.
+ */
+export type TimeoutOption = {
+    timeout?: number;
+};
+export type SoftOption = {
+    soft?: boolean;
+};
+export type MessageOrOptions = string | {
+    message?: string;
+};
+export type ExpectOptions = TimeoutOption & SoftOption & MessageOrOptions;
+export type ExpectTextOptions = {
+    ignoreCase?: boolean;
+    useInnerText?: boolean;
+};
+/**
+ * 4. Locator Options: These types are used for locating elements on a page.
+ * They are based on the parameters of Playwright's built-in locator methods.
+ */
+export type LocatorOptions = Parameters<Page['locator']>[1];
+export type GetByTextOptions = Parameters<Locator['getByText']>[1];
+export type GetByRoleTypes = Parameters<Locator['getByRole']>[0];
+export type GetByRoleOptions = Parameters<Locator['getByRole']>[1];
+export type GetByLabelOptions = Parameters<Locator['getByLabel']>[1];
+export type GetByPlaceholderOptions = Parameters<Locator['getByPlaceholder']>[1];
+//# sourceMappingURL=optional-parameter-types.d.ts.map

package/dist/vasu-playwright-lib/types/optional-parameter-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional-parameter-types.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/types/optional-parameter-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtD,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IAC3D,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpE,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACjD,MAAM,MAAM,UAAU,GAAG;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAC5C,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,aAAa,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAC1E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/vasu-playwright-lib/types/optional-parameter-types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Types.ts: This module provides type definitions that are used as optional parameters for utility functions in other modules.
+ * These types are based on the parameters of Playwright's built-in methods and are used to provide type safety and code completion.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=optional-parameter-types.js.map

package/dist/vasu-playwright-lib/types/optional-parameter-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional-parameter-types.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/types/optional-parameter-types.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

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

@@ -0,0 +1,199 @@
+/**
+ * action-utils.ts: This module provides a set of utility functions for performing various actions in Playwright tests.
+ * These actions include navigation, interaction with page elements, handling of dialogs, and more.
+ */
+import { Locator, Response } from 'playwright';
+import { CheckOptions, ClearOptions, ClickOptions, DoubleClickOptions, DragOptions, FillOptions, GotoOptions, HoverOptions, NavigationOptions, SelectOptions, TimeoutOption, TypeOptions, UploadOptions, UploadValues } from '../types/optional-parameter-types';
+/**
+ * 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.
+ */
+export declare function gotoURL(path: string, options?: GotoOptions): Promise<null | Response>;
+/**
+ * Waits for a specific page load state.
+ * @param {NavigationOptions} options - The navigation options.
+ */
+export declare function waitForPageLoadState(options?: NavigationOptions): Promise<void>;
+/**
+ * Reloads the current page.
+ * @param {NavigationOptions} options - The navigation options.
+ */
+export declare function reloadPage(options?: NavigationOptions): Promise<void>;
+/**
+ * Navigates back to the previous page.
+ * @param {NavigationOptions} options - The navigation options.
+ */
+export declare function goBack(options?: NavigationOptions): Promise<void>;
+/**
+ * Waits for a specified amount of time.
+ * @param {number} ms - The amount of time to wait in milliseconds.
+ */
+export declare function wait(ms: number): Promise<void>;
+/**
+ * 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.
+ */
+export declare function click(input: string | Locator, options?: ClickOptions): Promise<void>;
+/**
+ * Clicks on a specified element and waits for navigation.
+ * @param {string | Locator} input - The element to click on.
+ * @param {ClickOptions} options - The click options.
+ */
+export declare function clickAndNavigate(input: string | Locator, options?: ClickOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function fill(input: string | Locator, value: string, options?: FillOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function fillAndEnter(input: string | Locator, value: string, options?: FillOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function type(input: string | Locator, value: string, options?: TypeOptions): Promise<void>;
+/**
+ * Clears the value of a specified element.
+ * @param {string | Locator} input - The element to clear.
+ * @param {ClearOptions} options - The clear options.
+ */
+export declare function clear(input: string | Locator, options?: ClearOptions): Promise<void>;
+/**
+ * Checks a specified checkbox or radio button.
+ * @param {string | Locator} input - The checkbox or radio button to check.
+ * @param {CheckOptions} options - The check options.
+ */
+export declare function check(input: string | Locator, options?: CheckOptions): Promise<void>;
+/**
+ * Unchecks a specified checkbox or radio button.
+ * @param {string | Locator} input - The checkbox or radio button to uncheck.
+ * @param {CheckOptions} options - The uncheck options.
+ */
+export declare function uncheck(input: string | Locator, options?: CheckOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function selectByValue(input: string | Locator, value: string, options?: SelectOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function selectByValues(input: string | Locator, value: Array<string>, options?: SelectOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function selectByText(input: string | Locator, text: string, options?: SelectOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function selectByIndex(input: string | Locator, index: number, options?: SelectOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function acceptAlert(input: string | Locator, promptText?: string): Promise<string>;
+/**
+ * Dismisses an alert dialog.
+ * @param {string | Locator} input - The element to click to trigger the alert.
+ * @returns {Promise<string>} - The message of the dialog.
+ */
+export declare function dismissAlert(input: string | Locator): Promise<string>;
+/**
+ * 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.
+ */
+export declare function getAlertText(input: string | Locator): Promise<string>;
+/**
+ * Hovers over a specified element.
+ * @param {string | Locator} input - The element to hover over.
+ * @param {HoverOptions} options - The hover options.
+ */
+export declare function hover(input: string | Locator, options?: HoverOptions): Promise<void>;
+/**
+ * Focuses on a specified element.
+ * @param {string | Locator} input - The element to focus on.
+ * @param {TimeoutOption} options - The timeout options.
+ */
+export declare function focus(input: string | Locator, options?: TimeoutOption): Promise<void>;
+/**
+ * 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.
+ */
+export declare function dragAndDrop(input: string | Locator, dest: string | Locator, options?: DragOptions): Promise<void>;
+/**
+ * Double clicks on a specified element.
+ * @param {string | Locator} input - The element to double click on.
+ * @param {DoubleClickOptions} options - The double click options.
+ */
+export declare function doubleClick(input: string | Locator, options?: DoubleClickOptions): Promise<void>;
+/**
+ * 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.
+ */
+export declare function downloadFile(input: string | Locator, path: string): Promise<void>;
+/**
+ * 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.
+ */
+export declare function uploadFiles(input: string | Locator, path: UploadValues, options?: UploadOptions): Promise<void>;
+/**
+ * Scrolls a specified element into view.
+ * @param {string | Locator} input - The element to scroll into view.
+ * @param {TimeoutOption} options - The timeout options.
+ */
+export declare function scrollLocatorIntoView(input: string | Locator, options?: TimeoutOption): Promise<void>;
+/**
+ * 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.
+ */
+export declare function clickByJS(input: string | Locator, options?: TimeoutOption): Promise<void>;
+//# sourceMappingURL=action-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action-utils.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/action-utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAU,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,WAAW,EACX,aAAa,EACb,YAAY,EAEb,MAAM,mCAAmC,CAAC;AAK3C;;;GAGG;AAEH;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAsC,GAAG,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,CAErH;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAQrF;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvE;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGpD;AAED;;;GAGG;AAEH;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1F;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAMrG;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvG;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/G;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvG;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1F;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1F;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5F;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAGlH;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,MAAM,GAAG,OAAO,EACvB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EACpB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAGhH;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAGlH;AAED;;;;GAIG;AAEH;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAW/F;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAW3E;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAW3E;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1F;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3F;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAC/B,KAAK,EAAE,MAAM,GAAG,OAAO,EACvB,IAAI,EAAE,MAAM,GAAG,OAAO,EACtB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,IAAI,CAAC,CAIf;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGtG;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASvF;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrH;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3G;AAED;;;GAGG;AAEH;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAG/F"}