webship-js 2.0.6 → 2.0.7

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 (185) hide show
  1. package/.drone.yml +0 -0
  2. package/.harness/webship-js-pipeline.yml +0 -0
  3. package/.semaphore/semaphore.yml +0 -0
  4. package/.teamcity/pom.xml +0 -0
  5. package/.teamcity/settings.kts +0 -0
  6. package/.travis.yml +0 -0
  7. package/CLAUDE.md +1 -1
  8. package/Jenkinsfile +0 -0
  9. package/azure-pipelines.yml +0 -0
  10. package/bamboo-specs/bamboo.yml +0 -0
  11. package/bin/generate-reports.js +0 -0
  12. package/bin/init-webship.js +8 -9
  13. package/bin/postinstall.js +0 -0
  14. package/buildspec.yml +0 -0
  15. package/cloudbuild.yaml +0 -0
  16. package/codefresh.yml +0 -0
  17. package/docs/00-quick-start.md +0 -0
  18. package/docs/01-getting-started.md +0 -0
  19. package/docs/03-selector-registry.md +0 -0
  20. package/docs/05-web-first-assertions.md +2 -0
  21. package/docs/06-network-and-dialogs.md +0 -0
  22. package/docs/07-auth-state.md +0 -0
  23. package/docs/08-clock-mocking.md +0 -0
  24. package/docs/09-api-testing.md +0 -0
  25. package/docs/11-debugging.md +0 -0
  26. package/docs/12-ai-agent-guide.md +0 -0
  27. package/docs/13-faq.md +0 -0
  28. package/docs/14-recipes-cookbook.md +0 -0
  29. package/docs/15-tag-conventions.md +0 -0
  30. package/docs/16-ci-cd.md +0 -0
  31. package/docs/advanced-screenshots/then-i-save-fullscreen-screenshot.md +0 -0
  32. package/docs/advanced-screenshots/then-i-save-width-x-height-screenshot.md +0 -0
  33. package/docs/advanced-screenshots/when-i-save-screenshot-name-filename.md +0 -0
  34. package/docs/advanced-screenshots.md +0 -0
  35. package/docs/advanced-selectors.md +0 -0
  36. package/docs/api-step-definitions.md +0 -0
  37. package/docs/global-settings.md +4 -2
  38. package/docs/install-webship-js/ddev-webship-js.md +0 -0
  39. package/docs/step-definitions/given-i-am-anonymous-user.md +0 -0
  40. package/docs/step-definitions/given-i-am-homepage.md +0 -0
  41. package/docs/step-definitions/given-i-am-specific-page.md +0 -0
  42. package/docs/step-definitions/then-i-should-be.md +0 -0
  43. package/docs/step-definitions/then-i-should-see.md +6 -0
  44. package/docs/step-definitions/then-item-checkbox.md +0 -0
  45. package/docs/step-definitions/then-item-link-should-contain-url.md +0 -0
  46. package/docs/step-definitions/then-item-should-contain.md +0 -0
  47. package/docs/step-definitions/then-radio-button-value-should-be-selected.md +0 -0
  48. package/docs/step-definitions/then-response-status-code-should-be-number.md +0 -0
  49. package/docs/step-definitions/then-value-radio-button-selected.md +0 -0
  50. package/docs/step-definitions/when-i-attach-file-file-name-element.md +0 -0
  51. package/docs/step-definitions/when-i-check-checkbox.md +0 -0
  52. package/docs/step-definitions/when-i-click-link.md +0 -0
  53. package/docs/step-definitions/when-i-click-operation-text-row.md +0 -0
  54. package/docs/step-definitions/when-i-fill.md +0 -0
  55. package/docs/step-definitions/when-i-go-homepage.md +0 -0
  56. package/docs/step-definitions/when-i-go-specific-page.md +0 -0
  57. package/docs/step-definitions/when-i-move-backward-one-page.md +0 -0
  58. package/docs/step-definitions/when-i-move-forward-one-page.md +0 -0
  59. package/docs/step-definitions/when-i-press-button.md +0 -0
  60. package/docs/step-definitions/when-i-reload-page.md +0 -0
  61. package/docs/step-definitions/when-i-scroll.md +0 -0
  62. package/docs/step-definitions/when-i-select-option-select-list.md +0 -0
  63. package/docs/step-definitions/when-i-select-radio-button-value.md +0 -0
  64. package/docs/step-definitions/when-i-uncheck-checkbox.md +0 -0
  65. package/docs/step-definitions/when-i-wait-ajax-finish.md +0 -0
  66. package/docs/step-definitions/when-i-wait.md +0 -0
  67. package/docs/step-definitions.md +0 -0
  68. package/examples/account.html +0 -0
  69. package/examples/ajax-wait-examples.html +0 -0
  70. package/examples/cookies.html +0 -0
  71. package/examples/date.html +0 -0
  72. package/examples/dynamic-examples.html +0 -0
  73. package/examples/element-visibility.html +17 -0
  74. package/examples/element.html +0 -0
  75. package/examples/field.html +0 -0
  76. package/examples/keyboard.html +0 -0
  77. package/examples/links.html +0 -0
  78. package/examples/modal.html +0 -0
  79. package/examples/native-dialogs.html +22 -0
  80. package/examples/path.html +0 -0
  81. package/examples/table.html +0 -0
  82. package/examples/test--modal-dialogs.html +0 -0
  83. package/examples/test--when--i-additionally-select.html +0 -0
  84. package/examples/test--when--i-select-radio-button.html +0 -0
  85. package/examples/video-demo.html +0 -0
  86. package/examples/web-first-text.html +18 -0
  87. package/package.json +2 -2
  88. package/playwright.config.ts +0 -0
  89. package/tests/assets/test-document.pdf +0 -0
  90. package/tests/features/ajax-wait-examples.feature +0 -0
  91. package/tests/features/cookie.feature +0 -0
  92. package/tests/features/date.feature +0 -0
  93. package/tests/features/dynamic-content-examples.feature +0 -0
  94. package/tests/features/element.feature +0 -0
  95. package/tests/features/field.feature +0 -0
  96. package/tests/features/keyboard.feature +0 -0
  97. package/tests/features/link.feature +0 -0
  98. package/tests/features/modal-advanced-example.feature +0 -0
  99. package/tests/features/modal-basic-example.feature +0 -0
  100. package/tests/features/modal-error-handling-example.feature +0 -0
  101. package/tests/features/modal.feature +0 -0
  102. package/tests/features/path.feature +0 -0
  103. package/tests/features/pronoun-prefix-steps.feature +81 -0
  104. package/tests/features/response.feature +0 -0
  105. package/tests/features/responsive.feature +0 -0
  106. package/tests/features/table.feature +0 -0
  107. package/tests/features/test--given--i-am-an-anonymous-user.feature +0 -0
  108. package/tests/features/test--then--i-save-screenshot.feature +0 -0
  109. package/tests/features/test--then--i-see-locator.feature +0 -0
  110. package/tests/features/test--then--i-should-not-see-an-element.feature +11 -1
  111. package/tests/features/test--then--i-should-see-n-elements.feature +0 -0
  112. package/tests/features/test--then--print-current-url-and-response.feature +0 -0
  113. package/tests/features/test--when--i-additionally-select.feature +0 -0
  114. package/tests/features/test--when--i-follow.feature +0 -0
  115. package/tests/features/test--when--i-select-radio-button.feature +0 -0
  116. package/tests/features/video.feature +0 -0
  117. package/tests/features/wait.feature +0 -0
  118. package/tests/features/web-first-text.feature +21 -0
  119. package/tests/features/yaml.feature +0 -0
  120. package/tests/reports/README.md +0 -0
  121. package/tests/selectors/_canonical-keys.json +0 -0
  122. package/tests/selectors/back-end-selectors.json +0 -0
  123. package/tests/selectors/cms-contentful-admin.json +0 -0
  124. package/tests/selectors/cms-craft-admin.json +0 -0
  125. package/tests/selectors/cms-drupal-cms-gin.json +0 -0
  126. package/tests/selectors/cms-drupal-core-claro.json +0 -0
  127. package/tests/selectors/cms-generic-admin.json +0 -0
  128. package/tests/selectors/cms-ghost-admin.json +0 -0
  129. package/tests/selectors/cms-joomla-admin.json +0 -0
  130. package/tests/selectors/cms-magento2-admin.json +0 -0
  131. package/tests/selectors/cms-prestashop-admin.json +0 -0
  132. package/tests/selectors/cms-shopify-admin.json +0 -0
  133. package/tests/selectors/cms-strapi-admin.json +0 -0
  134. package/tests/selectors/cms-typo3-admin.json +0 -0
  135. package/tests/selectors/cms-woocommerce-front.json +0 -0
  136. package/tests/selectors/cms-wordpress-admin.json +0 -0
  137. package/tests/selectors/framework-ant-design.json +0 -0
  138. package/tests/selectors/framework-bootstrap.json +0 -0
  139. package/tests/selectors/framework-bulma.json +0 -0
  140. package/tests/selectors/framework-chakra.json +0 -0
  141. package/tests/selectors/framework-foundation.json +0 -0
  142. package/tests/selectors/framework-material-ui.json +0 -0
  143. package/tests/selectors/framework-shadcn.json +0 -0
  144. package/tests/selectors/framework-tailwind.json +0 -0
  145. package/tests/selectors/framework-vuetify.json +0 -0
  146. package/tests/selectors/front-end-selectors.json +0 -0
  147. package/tests/selectors/homepage-selectors.json +0 -0
  148. package/tests/step-definitions/a11y.steps.js +1 -1
  149. package/tests/step-definitions/action.steps.js +0 -0
  150. package/tests/step-definitions/api.steps.js +0 -0
  151. package/tests/step-definitions/assertion.steps.js +18 -3
  152. package/tests/step-definitions/auth.steps.js +1 -1
  153. package/tests/step-definitions/clock.steps.js +2 -2
  154. package/tests/step-definitions/cookie.steps.js +0 -0
  155. package/tests/step-definitions/debug.steps.js +0 -0
  156. package/tests/step-definitions/dialog.steps.js +4 -4
  157. package/tests/step-definitions/element.steps.js +0 -0
  158. package/tests/step-definitions/field.steps.js +0 -0
  159. package/tests/step-definitions/file-download.steps.js +0 -0
  160. package/tests/step-definitions/form.steps.js +0 -0
  161. package/tests/step-definitions/iframe.steps.js +1 -1
  162. package/tests/step-definitions/input.steps.js +0 -0
  163. package/tests/step-definitions/javascript.steps.js +0 -0
  164. package/tests/step-definitions/keyboard.steps.js +0 -0
  165. package/tests/step-definitions/link.steps.js +0 -0
  166. package/tests/step-definitions/metatag.steps.js +0 -0
  167. package/tests/step-definitions/modal.steps.js +0 -0
  168. package/tests/step-definitions/navigation.steps.js +0 -0
  169. package/tests/step-definitions/network.steps.js +1 -1
  170. package/tests/step-definitions/path.steps.js +0 -0
  171. package/tests/step-definitions/response.steps.js +0 -0
  172. package/tests/step-definitions/responsive.steps.js +0 -0
  173. package/tests/step-definitions/rest.steps.js +0 -0
  174. package/tests/step-definitions/screenshot.steps.js +0 -0
  175. package/tests/step-definitions/scroll.steps.js +0 -0
  176. package/tests/step-definitions/selectors.steps.js +0 -0
  177. package/tests/step-definitions/storage.steps.js +0 -0
  178. package/tests/step-definitions/table.steps.js +0 -0
  179. package/tests/step-definitions/video.steps.js +0 -0
  180. package/tests/step-definitions/wait.steps.js +3 -3
  181. package/tests/step-definitions/web-first.steps.js +14 -3
  182. package/tests/step-definitions/xml.steps.js +1 -1
  183. package/tests/step-definitions/yaml.steps.js +1 -1
  184. package/tsconfig.json +0 -0
  185. package/videos/README.md +0 -0
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -889,7 +889,7 @@ Then(/^the page should not violate the accessibility rule "([^"]*)"$/, async fun
889
889
  * Then I print accessibility violations
890
890
  *
891
891
  */
892
- Then(/^(I |we )*print accessibility violations$/, async function () {
892
+ Then(/^(I |we )*print accessibility violations$/, async function (pronounCase) {
893
893
  const result = await runAxe(this);
894
894
  if (result.violations.length === 0) {
895
895
  console.log('\n--- Accessibility violations: none ---');
File without changes
File without changes
@@ -86,17 +86,32 @@ Then(/^(I |we )*should( not)* see "([^"]*)?" in( the)* "([^"]*)?" row$/, async f
86
86
  // ---------------------------------------------------------------------------
87
87
 
88
88
  /**
89
- * Assert that an element with a given label exists (or does not) on the page.
89
+ * Assert that an element is, or is not, visible on the page. The element is
90
+ * named by its exact visible text; a `<label for="...">` stands for the
91
+ * control it labels. The text is not a CSS selector: for a selector use
92
+ * `"<selector>" should be visible` or `"<selector>" should not be visible`.
93
+ *
94
+ * "should not see" is the opposite of "should see": it passes when no element
95
+ * named that way is visible, so an element that is hidden does not fail it.
90
96
  *
91
97
  * Example #1: Then I should see a "Username" element
92
98
  * Example #2: Then I should not see a "Username" element
93
99
  * Example #3: And we should see an "Email" element
100
+ * Example #4: Then I should not see an "Email" element
101
+ * Example #5: And we should not see a "Promo banner" element
94
102
  *
95
103
  */
96
104
  Then(/^(I |we )*should( not)* see (a|an) "([^"]*)?" element$/, async function (pronounCase, notCase, aAnCase, element) {
97
105
  if (notCase) {
98
- const text = await this.page.locator('body').textContent() || '';
99
- assert.ok(!text.includes(element), `Page should NOT contain element text "${element}" but it does.`);
106
+ // Same lookup as the positive branch, over every match, without waiting.
107
+ const named = this.page.getByText(element, { exact: true });
108
+ const forIds = await named.evaluateAll((nodes) => nodes.map((node) => node.getAttribute('for')));
109
+ for (let i = 0; i < forIds.length; i++) {
110
+ const target = forIds[i]
111
+ ? this.page.locator(`[id="${forIds[i].replace(/["\\]/g, '\\$&')}"]`).first()
112
+ : named.nth(i);
113
+ assert.ok(!(await target.isVisible()), `Element "${element}" should NOT be visible but it is.`);
114
+ }
100
115
  } else {
101
116
  const loc = this.page.getByText(element, { exact: true }).first();
102
117
  const forAttr = await loc.getAttribute('for').catch(() => null);
@@ -115,7 +115,7 @@ Given(/^(I |we )*restore the auth state from "([^"]*)"$/, async function (pronou
115
115
  * Then I should see "Login"
116
116
  *
117
117
  */
118
- Given(/^(I |we )*clear the auth state$/, async function () {
118
+ Given(/^(I |we )*clear the auth state$/, async function (pronoun) {
119
119
  await this.context.clearCookies();
120
120
  try {
121
121
  await this.page.evaluate(() => {
@@ -85,7 +85,7 @@ When(/^(I |we )*advance the clock by (\d+) minutes?$/, async function (pronoun,
85
85
  * Example #5: When I pause the clock
86
86
  *
87
87
  */
88
- When(/^(I |we )*pause the clock$/, async function () {
88
+ When(/^(I |we )*pause the clock$/, async function (pronoun) {
89
89
  try { await this.page.clock.pauseAt(await this.page.evaluate(() => Date.now())); }
90
90
  catch (e) { throw friendly({ action: 'pause the clock', cause: e, hint: ISO_HINT }); }
91
91
  });
@@ -100,7 +100,7 @@ When(/^(I |we )*pause the clock$/, async function () {
100
100
  * Example #5: When I resume the clock
101
101
  *
102
102
  */
103
- When(/^(I |we )*resume the clock$/, async function () {
103
+ When(/^(I |we )*resume the clock$/, async function (pronoun) {
104
104
  try { await this.page.clock.resume(); }
105
105
  catch (e) { throw friendly({ action: 'resume the clock', cause: e, hint: 'pause the clock first via "When I pause the clock".' }); }
106
106
  });
File without changes
File without changes
@@ -59,7 +59,7 @@ function attach(world, action, promptInput, once) {
59
59
  * Then the last dialog type should be "confirm"
60
60
  *
61
61
  */
62
- Given(/^(I |we )*will accept the next dialog$/, function () {
62
+ Given(/^(I |we )*will accept the next dialog$/, function (pronoun) {
63
63
  attach(this, 'accept', undefined, true);
64
64
  });
65
65
 
@@ -80,7 +80,7 @@ Given(/^(I |we )*will accept the next dialog$/, function () {
80
80
  * When I close the tab
81
81
  *
82
82
  */
83
- Given(/^(I |we )*will dismiss the next dialog$/, function () {
83
+ Given(/^(I |we )*will dismiss the next dialog$/, function (pronoun) {
84
84
  attach(this, 'dismiss', undefined, true);
85
85
  });
86
86
 
@@ -171,7 +171,7 @@ Then(/^the last dialog type should be "([^"]*)"$/, function (type) {
171
171
  * When I follow "Discard changes"
172
172
  *
173
173
  */
174
- Given(/^(I |we )*accept all confirmation dialogs$/, function () {
174
+ Given(/^(I |we )*accept all confirmation dialogs$/, function (pronoun) {
175
175
  attach(this, 'accept', undefined, false);
176
176
  });
177
177
 
@@ -188,6 +188,6 @@ Given(/^(I |we )*accept all confirmation dialogs$/, function () {
188
188
  * When I follow "Leave page"
189
189
  *
190
190
  */
191
- Given(/^(I |we )*do not accept any confirmation dialogs$/, function () {
191
+ Given(/^(I |we )*do not accept any confirmation dialogs$/, function (pronoun) {
192
192
  attach(this, 'dismiss', undefined, false);
193
193
  });
File without changes
File without changes
File without changes
File without changes
@@ -77,7 +77,7 @@ When(/^(I |we )*switch to iframe with locator "([^"]*)"$/, async function (prono
77
77
  * And I press "Refresh"
78
78
  *
79
79
  */
80
- When(/^(I |we )*switch to the root document$/, async function () {
80
+ When(/^(I |we )*switch to the root document$/, async function (pronoun) {
81
81
  this.frame = null;
82
82
  });
83
83
 
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -216,7 +216,7 @@ Given(/^the network is online$/, async function () {
216
216
  * Then a GET request to "**\/api/feed/page=2" should have been made
217
217
  *
218
218
  */
219
- Given(/^(I |we )*start recording network requests$/, function () {
219
+ Given(/^(I |we )*start recording network requests$/, function (pronounCase) {
220
220
  ensureRequestLog(this);
221
221
  });
222
222
 
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -324,7 +324,7 @@ When(/^(I |we )*wait until at least (\d+) elements? match(?:es)? "([^"]*)"$/, as
324
324
  * And I wait until requests are complete
325
325
  *
326
326
  */
327
- When(/^(I |we )*wait until (the network is idle|requests are complete|network goes quiet)$/, async function () {
327
+ When(/^(I |we )*wait until (the network is idle|requests are complete|network goes quiet)$/, async function (pronounCase, phrasing) {
328
328
  await smartSettle(this.page, 10000);
329
329
  });
330
330
 
@@ -344,7 +344,7 @@ When(/^(I |we )*wait until (the network is idle|requests are complete|network go
344
344
  * Then "<#root>" should be attached
345
345
  *
346
346
  */
347
- When(/^(I |we )*wait until( the)* page is interactive$/, async function () {
347
+ When(/^(I |we )*wait until( the)* page is interactive$/, async function (pronounCase, theCase) {
348
348
  await this.page.waitForSelector('body', { state: 'attached', timeout: 10000 });
349
349
  await this.page.waitForLoadState('domcontentloaded', { timeout: 10000 });
350
350
  });
@@ -368,7 +368,7 @@ When(/^(I |we )*wait until( the)* page is interactive$/, async function () {
368
368
  * Then I should not see "Saved"
369
369
  *
370
370
  */
371
- When(/^(I |we )*wait until pending timers settle$/, async function () {
371
+ When(/^(I |we )*wait until pending timers settle$/, async function (pronounCase) {
372
372
  await this.page.waitForFunction(
373
373
  () => {
374
374
  const t = window.__webshipPendingTimers;
@@ -17,6 +17,13 @@ function parseTimeout(secondsStr) {
17
17
  return n > 0 ? n * 1000 : 5000;
18
18
  }
19
19
 
20
+ // Collapse every run of whitespace (line breaks, tabs, non-breaking spaces) to
21
+ // one space and trim, so markup that wraps a line does not change the text a
22
+ // visitor reads.
23
+ function normalizeText(value) {
24
+ return String(value || '').replace(/\s+/g, ' ').trim();
25
+ }
26
+
20
27
  // Poll fn() until it returns truthy, or timeout. fn() returns a value;
21
28
  // `predicate` decides pass/fail. Returns the last value seen.
22
29
  async function poll(fn, predicate, timeout, message) {
@@ -184,7 +191,10 @@ Then(/^"([^"]*)" should have text "([^"]*)"(?: within (\d+) seconds?)?$/, async
184
191
  });
185
192
 
186
193
  /**
187
- * Assert an element's textContent contains an expected substring.
194
+ * Assert an element's textContent contains an expected substring. Runs of
195
+ * whitespace are collapsed to one space and trimmed on both sides first, so
196
+ * markup that wraps a line still matches. Use `should have text` for the
197
+ * exact match.
188
198
  *
189
199
  * Example #1: Then "h1" should contain text "Welcome"
190
200
  * Example #2: Then ".badge" should contain text "unread" within 3 seconds
@@ -195,9 +205,10 @@ Then(/^"([^"]*)" should have text "([^"]*)"(?: within (\d+) seconds?)?$/, async
195
205
  */
196
206
  Then(/^"([^"]*)" should contain text "([^"]*)"(?: within (\d+) seconds?)?$/, async function (selector, text, sec) {
197
207
  const loc = this.page.locator(selector).first();
208
+ const expected = normalizeText(text);
198
209
  await poll(
199
- () => loc.textContent(),
200
- (v) => (v || '').includes(text),
210
+ async () => normalizeText(await loc.textContent()),
211
+ (v) => v.includes(expected),
201
212
  parseTimeout(sec),
202
213
  `Expected "${selector}" to contain text "${text}"`
203
214
  );
@@ -406,6 +406,6 @@ Then('the XML should not use the namespace {string}', async function (ns) {
406
406
  * Example #5: When I print last XML response
407
407
  *
408
408
  */
409
- When(/^(I |we )*print last XML response$/, async function () {
409
+ When(/^(I |we )*print last XML response$/, async function (pronounCase) {
410
410
  console.log(this._rawResponse || '(no response)');
411
411
  });
@@ -908,6 +908,6 @@ Then('the YAML should not use the namespace {string}', function (ns) {
908
908
  * And we print last YAML response
909
909
  *
910
910
  */
911
- When(/^(I |we )*print last YAML response$/, async function () {
911
+ When(/^(I |we )*print last YAML response$/, async function (pronounCase) {
912
912
  console.log(this._rawYamlResponse || '(no response)');
913
913
  });
package/tsconfig.json CHANGED
File without changes
package/videos/README.md CHANGED
File without changes