@serenity-js/webdriverio 3.10.2 → 3.10.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/esm/adapter/WebdriverIOFrameworkAdapter.d.ts +1 -0
  3. package/esm/adapter/WebdriverIOFrameworkAdapter.d.ts.map +1 -1
  4. package/esm/adapter/WebdriverIOFrameworkAdapter.js +1 -0
  5. package/esm/adapter/WebdriverIOFrameworkAdapter.js.map +1 -1
  6. package/esm/config/WebdriverIOConfig.d.ts +35 -68
  7. package/esm/config/WebdriverIOConfig.d.ts.map +1 -1
  8. package/esm/screenplay/abilities/BrowseTheWebWithWebdriverIO.d.ts +3 -3
  9. package/esm/screenplay/abilities/BrowseTheWebWithWebdriverIO.d.ts.map +1 -1
  10. package/esm/screenplay/abilities/BrowseTheWebWithWebdriverIO.js +1 -0
  11. package/esm/screenplay/abilities/BrowseTheWebWithWebdriverIO.js.map +1 -1
  12. package/esm/screenplay/models/WebdriverIOBrowsingSession.d.ts +3 -3
  13. package/esm/screenplay/models/WebdriverIOBrowsingSession.d.ts.map +1 -1
  14. package/esm/screenplay/models/WebdriverIOBrowsingSession.js +1 -0
  15. package/esm/screenplay/models/WebdriverIOBrowsingSession.js.map +1 -1
  16. package/esm/screenplay/models/WebdriverIOCookie.d.ts +2 -2
  17. package/esm/screenplay/models/WebdriverIOCookie.d.ts.map +1 -1
  18. package/esm/screenplay/models/WebdriverIOCookie.js +1 -0
  19. package/esm/screenplay/models/WebdriverIOCookie.js.map +1 -1
  20. package/esm/screenplay/models/WebdriverIOModalDialogHandler.d.ts +2 -2
  21. package/esm/screenplay/models/WebdriverIOModalDialogHandler.d.ts.map +1 -1
  22. package/esm/screenplay/models/WebdriverIOModalDialogHandler.js +1 -0
  23. package/esm/screenplay/models/WebdriverIOModalDialogHandler.js.map +1 -1
  24. package/esm/screenplay/models/WebdriverIOPage.d.ts +6 -6
  25. package/esm/screenplay/models/WebdriverIOPage.d.ts.map +1 -1
  26. package/esm/screenplay/models/WebdriverIOPage.js +1 -0
  27. package/esm/screenplay/models/WebdriverIOPage.js.map +1 -1
  28. package/esm/screenplay/models/WebdriverIOPageElement.d.ts +2 -2
  29. package/esm/screenplay/models/WebdriverIOPageElement.d.ts.map +1 -1
  30. package/esm/screenplay/models/WebdriverIOPageElement.js +1 -0
  31. package/esm/screenplay/models/WebdriverIOPageElement.js.map +1 -1
  32. package/esm/screenplay/models/locators/WebdriverIOLocator.d.ts +14 -14
  33. package/esm/screenplay/models/locators/WebdriverIOLocator.d.ts.map +1 -1
  34. package/esm/screenplay/models/locators/WebdriverIOLocator.js +1 -0
  35. package/esm/screenplay/models/locators/WebdriverIOLocator.js.map +1 -1
  36. package/esm/screenplay/models/locators/WebdriverIORootLocator.d.ts +4 -4
  37. package/esm/screenplay/models/locators/WebdriverIORootLocator.d.ts.map +1 -1
  38. package/esm/screenplay/models/locators/WebdriverIORootLocator.js +1 -0
  39. package/esm/screenplay/models/locators/WebdriverIORootLocator.js.map +1 -1
  40. package/lib/adapter/WebdriverIOFrameworkAdapter.d.ts +1 -0
  41. package/lib/adapter/WebdriverIOFrameworkAdapter.d.ts.map +1 -1
  42. package/lib/adapter/WebdriverIOFrameworkAdapter.js +1 -0
  43. package/lib/adapter/WebdriverIOFrameworkAdapter.js.map +1 -1
  44. package/lib/config/WebdriverIOConfig.d.ts +35 -68
  45. package/lib/config/WebdriverIOConfig.d.ts.map +1 -1
  46. package/lib/screenplay/abilities/BrowseTheWebWithWebdriverIO.d.ts +3 -3
  47. package/lib/screenplay/abilities/BrowseTheWebWithWebdriverIO.d.ts.map +1 -1
  48. package/lib/screenplay/abilities/BrowseTheWebWithWebdriverIO.js +1 -0
  49. package/lib/screenplay/abilities/BrowseTheWebWithWebdriverIO.js.map +1 -1
  50. package/lib/screenplay/models/WebdriverIOBrowsingSession.d.ts +3 -3
  51. package/lib/screenplay/models/WebdriverIOBrowsingSession.d.ts.map +1 -1
  52. package/lib/screenplay/models/WebdriverIOBrowsingSession.js +1 -0
  53. package/lib/screenplay/models/WebdriverIOBrowsingSession.js.map +1 -1
  54. package/lib/screenplay/models/WebdriverIOCookie.d.ts +2 -2
  55. package/lib/screenplay/models/WebdriverIOCookie.d.ts.map +1 -1
  56. package/lib/screenplay/models/WebdriverIOCookie.js +1 -0
  57. package/lib/screenplay/models/WebdriverIOCookie.js.map +1 -1
  58. package/lib/screenplay/models/WebdriverIOModalDialogHandler.d.ts +2 -2
  59. package/lib/screenplay/models/WebdriverIOModalDialogHandler.d.ts.map +1 -1
  60. package/lib/screenplay/models/WebdriverIOModalDialogHandler.js +1 -0
  61. package/lib/screenplay/models/WebdriverIOModalDialogHandler.js.map +1 -1
  62. package/lib/screenplay/models/WebdriverIOPage.d.ts +6 -6
  63. package/lib/screenplay/models/WebdriverIOPage.d.ts.map +1 -1
  64. package/lib/screenplay/models/WebdriverIOPage.js +1 -0
  65. package/lib/screenplay/models/WebdriverIOPage.js.map +1 -1
  66. package/lib/screenplay/models/WebdriverIOPageElement.d.ts +2 -2
  67. package/lib/screenplay/models/WebdriverIOPageElement.d.ts.map +1 -1
  68. package/lib/screenplay/models/WebdriverIOPageElement.js +1 -0
  69. package/lib/screenplay/models/WebdriverIOPageElement.js.map +1 -1
  70. package/lib/screenplay/models/locators/WebdriverIOLocator.d.ts +14 -14
  71. package/lib/screenplay/models/locators/WebdriverIOLocator.d.ts.map +1 -1
  72. package/lib/screenplay/models/locators/WebdriverIOLocator.js +1 -0
  73. package/lib/screenplay/models/locators/WebdriverIOLocator.js.map +1 -1
  74. package/lib/screenplay/models/locators/WebdriverIORootLocator.d.ts +4 -4
  75. package/lib/screenplay/models/locators/WebdriverIORootLocator.d.ts.map +1 -1
  76. package/lib/screenplay/models/locators/WebdriverIORootLocator.js +1 -0
  77. package/lib/screenplay/models/locators/WebdriverIORootLocator.js.map +1 -1
  78. package/package.json +15 -15
  79. package/src/adapter/WebdriverIOFrameworkAdapter.ts +3 -2
  80. package/src/config/WebdriverIOConfig.ts +35 -68
  81. package/src/screenplay/abilities/BrowseTheWebWithWebdriverIO.ts +4 -3
  82. package/src/screenplay/models/WebdriverIOBrowsingSession.ts +3 -2
  83. package/src/screenplay/models/WebdriverIOCookie.ts +3 -2
  84. package/src/screenplay/models/WebdriverIOModalDialogHandler.ts +3 -2
  85. package/src/screenplay/models/WebdriverIOPage.ts +7 -6
  86. package/src/screenplay/models/WebdriverIOPageElement.ts +8 -7
  87. package/src/screenplay/models/locators/WebdriverIOLocator.ts +19 -18
  88. package/src/screenplay/models/locators/WebdriverIORootLocator.ts +5 -4
@@ -1,7 +1,8 @@
1
+ import 'webdriverio';
2
+
1
3
  import { f, LogicError } from '@serenity-js/core';
2
4
  import type { PageElement, RootLocator, Selector } from '@serenity-js/web';
3
5
  import { ByCss, ByCssContainingText, ByDeepCss, ById, ByTagName, ByXPath, Locator } from '@serenity-js/web';
4
- import type { Element } from 'webdriverio';
5
6
 
6
7
  import type { WebdriverIOErrorHandler } from '../WebdriverIOErrorHandler.js';
7
8
  import { WebdriverIOPageElement } from '../WebdriverIOPageElement.js';
@@ -12,10 +13,10 @@ import type { WebdriverIORootLocator } from './WebdriverIORootLocator.js';
12
13
  *
13
14
  * @group Models
14
15
  */
15
- export class WebdriverIOLocator extends Locator<Element, string> {
16
+ export class WebdriverIOLocator extends Locator<WebdriverIO.Element, string> {
16
17
 
17
18
  constructor(
18
- parent: RootLocator<Element>,
19
+ parent: RootLocator<WebdriverIO.Element>,
19
20
  selector: Selector,
20
21
  private readonly errorHandler: WebdriverIOErrorHandler,
21
22
  ) {
@@ -61,7 +62,7 @@ export class WebdriverIOLocator extends Locator<Element, string> {
61
62
  }
62
63
  }
63
64
 
64
- async nativeElement(): Promise<Element> {
65
+ async nativeElement(): Promise<WebdriverIO.Element> {
65
66
  try {
66
67
  return await this.resolveNativeElement();
67
68
  }
@@ -70,7 +71,7 @@ export class WebdriverIOLocator extends Locator<Element, string> {
70
71
  }
71
72
  }
72
73
 
73
- protected async resolveNativeElement(): Promise<Element> {
74
+ protected async resolveNativeElement(): Promise<WebdriverIO.Element> {
74
75
  const parent = await this.parent.nativeElement();
75
76
 
76
77
  if (parent.error) {
@@ -86,28 +87,28 @@ export class WebdriverIOLocator extends Locator<Element, string> {
86
87
  return element;
87
88
  }
88
89
 
89
- async allNativeElements(): Promise<Array<Element>> {
90
+ async allNativeElements(): Promise<Array<WebdriverIO.Element>> {
90
91
  const parent = await this.parent.nativeElement();
91
92
  return parent.$$(this.nativeSelector());
92
93
  }
93
94
 
94
- of(parent: WebdriverIOLocator): Locator<Element, string> {
95
+ of(parent: WebdriverIOLocator): Locator<WebdriverIO.Element, string> {
95
96
  return new WebdriverIOLocator(parent, this.selector, this.errorHandler);
96
97
  }
97
98
 
98
- closestTo(child: WebdriverIOLocator): Locator<Element, string> {
99
+ closestTo(child: WebdriverIOLocator): Locator<WebdriverIO.Element, string> {
99
100
  return new WebdriverIOParentElementLocator(this.parent, this.selector, child, this.errorHandler);
100
101
  }
101
102
 
102
- locate(child: WebdriverIOLocator): Locator<Element, string> {
103
+ locate(child: WebdriverIOLocator): Locator<WebdriverIO.Element, string> {
103
104
  return new WebdriverIOLocator(this, child.selector, this.errorHandler);
104
105
  }
105
106
 
106
- element(): PageElement<Element> {
107
+ element(): PageElement<WebdriverIO.Element> {
107
108
  return new WebdriverIOPageElement(this);
108
109
  }
109
110
 
110
- async allElements(): Promise<Array<PageElement<Element>>> {
111
+ async allElements(): Promise<Array<PageElement<WebdriverIO.Element>>> {
111
112
  const elements = await this.allNativeElements();
112
113
 
113
114
  return elements.map(childElement =>
@@ -128,26 +129,26 @@ export class WebdriverIOLocator extends Locator<Element, string> {
128
129
  */
129
130
  export class WebdriverIOExistingElementLocator extends WebdriverIOLocator {
130
131
  constructor(
131
- parentRoot: RootLocator<Element>,
132
+ parentRoot: RootLocator<WebdriverIO.Element>,
132
133
  selector: Selector,
133
134
  errorHandler: WebdriverIOErrorHandler,
134
- private readonly existingNativeElement: Element,
135
+ private readonly existingNativeElement: WebdriverIO.Element,
135
136
  ) {
136
137
  super(parentRoot, selector, errorHandler);
137
138
  }
138
139
 
139
- async nativeElement(): Promise<Element> {
140
+ async nativeElement(): Promise<WebdriverIO.Element> {
140
141
  return this.existingNativeElement;
141
142
  }
142
143
 
143
- async allNativeElements(): Promise<Array<Element>> {
144
+ async allNativeElements(): Promise<Array<WebdriverIO.Element>> {
144
145
  return [ this.existingNativeElement ];
145
146
  }
146
147
  }
147
148
 
148
149
  class WebdriverIOParentElementLocator extends WebdriverIOLocator {
149
150
  constructor(
150
- parentRoot: RootLocator<Element>,
151
+ parentRoot: RootLocator<WebdriverIO.Element>,
151
152
  selector: Selector,
152
153
  private readonly child: WebdriverIOLocator,
153
154
  errorHandler: WebdriverIOErrorHandler
@@ -155,7 +156,7 @@ class WebdriverIOParentElementLocator extends WebdriverIOLocator {
155
156
  super(parentRoot, selector, errorHandler);
156
157
  }
157
158
 
158
- protected override async resolveNativeElement(): Promise<Element> {
159
+ protected override async resolveNativeElement(): Promise<WebdriverIO.Element> {
159
160
  const cssSelector = this.asCssSelector(this.selector);
160
161
  const child = await this.child.nativeElement();
161
162
 
@@ -169,7 +170,7 @@ class WebdriverIOParentElementLocator extends WebdriverIOLocator {
169
170
  );
170
171
  }
171
172
 
172
- override async allNativeElements(): Promise<Array<Element>> {
173
+ override async allNativeElements(): Promise<Array<WebdriverIO.Element>> {
173
174
  return [ await this.nativeElement() ];
174
175
  }
175
176
  }
@@ -1,13 +1,14 @@
1
+ import 'webdriverio';
2
+
1
3
  import { RootLocator } from '@serenity-js/web';
2
- import type { Browser, Element } from 'webdriverio';
3
4
 
4
5
  /**
5
6
  * WebdriverIO-specific implementation of {@apilink RootLocator}.
6
7
  *
7
8
  * @group Models
8
9
  */
9
- export class WebdriverIORootLocator extends RootLocator<Browser> {
10
- constructor(private readonly browser: Browser) {
10
+ export class WebdriverIORootLocator extends RootLocator<WebdriverIO.Browser> {
11
+ constructor(private readonly browser: WebdriverIO.Browser) {
11
12
  super();
12
13
  }
13
14
 
@@ -15,7 +16,7 @@ export class WebdriverIORootLocator extends RootLocator<Browser> {
15
16
  return true;
16
17
  }
17
18
 
18
- async nativeElement(): Promise<Pick<Browser, '$' | '$$'>> {
19
+ async nativeElement(): Promise<Pick<WebdriverIO.Browser, '$' | '$$'>> {
19
20
  return this.browser;
20
21
  }
21
22