Skip to content

[types/nightwatch] Add PageObjectModel types to support POM pattern in Nightwatch test suites #59626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 5 commits into from
Apr 1, 2022
Merged

[types/nightwatch] Add PageObjectModel types to support POM pattern in Nightwatch test suites #59626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8255d1e
Added PageObjectModel type including PageElements and ElementLocator …
reallymello Mar 31, 2022
2d187bd
Switched to using existing ElementProperties and modified that type t…
reallymello Mar 31, 2022
fceb147
Merge branch 'DefinitelyTyped:master' into master
reallymello Mar 31, 2022
9839961
Fixed linting issues and converted types to interfaces
reallymello Mar 31, 2022
4d8638b
Merge branch 'master' of https://github.com/reallymello/DefinitelyTyped
reallymello Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions types/nightwatch/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1194,7 +1194,7 @@ export interface ElementProperties {
* @example
* 'css selector'
*/
locateStrategy?: string;
locateStrategy?: LocateStrategy;

/**
* used to target a specific element in a query that results in multiple elements returned. Normally,
Expand Down Expand Up @@ -1626,11 +1626,11 @@ export interface EnhancedElementInstance<T> {
selector: string;
}

export type EnhancedSectionInstance<Commands = {}, Elements = {}, Sections extends EnhancedPageObjectSections = {}> = EnhancedPageObject<
Commands,
Elements,
Sections
>;
export type EnhancedSectionInstance<
Commands = {},
Elements = {},
Sections extends EnhancedPageObjectSections = {},
> = EnhancedPageObject<Commands, Elements, Sections>;

export interface EnhancedPageObjectSections {
[name: string]: EnhancedSectionInstance<any, any, any>;
Expand Down Expand Up @@ -4691,3 +4691,32 @@ export interface WebDriverProtocolMobileRelated {
*/
setContext(context: string, callback?: () => void): this;
}

/**
* Map of DOM element locators as shorthand string selectors based on
* global selector setting or ElementLocator
*
* @example
* const elements: PageElements {
* header: "h1",
* banner: {
* locateStrategy: "css selector",
* selector: "#bannerId"
* }
* }
*/
export interface PageElements {
[key: string]: string | ElementProperties;
}

/**
* Type for defining page object models allowing for optional type-safe
* inclusion of url, elements, sections, commands, and props properties.
*/
export interface PageObjectModel {
url?: string | ((...args: any) => string);
elements?: PageElements;
sections?: EnhancedPageObjectSections;
commands?: any;
props?: any;
}
12 changes: 5 additions & 7 deletions types/nightwatch/test/nightwatch-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import {
EnhancedSectionInstance,
NightwatchAPI,
NightwatchAssertion,
NightwatchBrowser,
NightwatchTests,
PageObjectModel,
} from 'nightwatch';

//
Expand Down Expand Up @@ -64,10 +64,8 @@ const testGeneral: NightwatchTests = {
},

'test user defined globals': () => {
browser
.url(`http://${browser.globals.username}:${browser.globals.password}@example.com`)
.end();
}
browser.url(`http://${browser.globals.username}:${browser.globals.password}@example.com`).end();
},
};

//
Expand Down Expand Up @@ -125,7 +123,7 @@ interface MenuSection
{ apps: AppsSection }
> {}

const googlePage = {
const googlePage: PageObjectModel = {
commands: [
{
submit(this: GooglePage) {
Expand All @@ -151,7 +149,7 @@ const googlePage = {

// export = googlePage;

const iFrame = {
const iFrame: PageObjectModel = {
elements: {
iframe: '#mce_0_ifr',
textbox: 'body#tinymce p',
Expand Down