Merge pull request #86 from ShellyDCMS/remove-focus-from-type

remove focus from type methods
ShellyDCMS · Apr 30, 2024 · 754422d · 754422d
2 parents 5616080 + 2f8d035
commit 754422d
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 26 deletions.
diff --git a/documents/classes/Assertable.md b/documents/classes/Assertable.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v2.0.54](../README.md) / [Modules](../modules.md) / Assertable
+[@shellygo/cypress-test-utils - v2.0.56](../README.md) / [Modules](../modules.md) / Assertable
 
 # Class: Assertable<T\>
 
@@ -67,10 +67,10 @@ class Driver {
 - [shouldBeDisabled](Assertable.md#shouldbedisabled)
 - [shouldBeEnabled](Assertable.md#shouldbeenabled)
 - [shouldBeFocused](Assertable.md#shouldbefocused)
-- [shouldBeGreaterThen](Assertable.md#shouldbegreaterthen)
-- [shouldBeGreaterThenOrEqual](Assertable.md#shouldbegreaterthenorequal)
-- [shouldBeLessThen](Assertable.md#shouldbelessthen)
-- [shouldBeLessThenOrEqual](Assertable.md#shouldbelessthenorequal)
+- [shouldBeGreaterThan](Assertable.md#shouldbegreaterthan)
+- [shouldBeGreaterThanOrEqual](Assertable.md#shouldbegreaterthanorequal)
+- [shouldBeLessThan](Assertable.md#shouldbelessthan)
+- [shouldBeLessThanOrEqual](Assertable.md#shouldbelessthanorequal)
 - [shouldBeSelected](Assertable.md#shouldbeselected)
 - [shouldBeVisible](Assertable.md#shouldbevisible)
 - [shouldContainText](Assertable.md#shouldcontaintext)
@@ -219,9 +219,9 @@ then(get.elementByTestId("selector")).shouldBeFocused()
 
 ___
 
-### shouldBeGreaterThen
+### shouldBeGreaterThan
 
-▸ **shouldBeGreaterThen**(`value`): `Chainable`<`T`\>
+▸ **shouldBeGreaterThan**(`value`): `Chainable`<`T`\>
 
 Asserts that the target is a number or a date greater than the given number or date n respectively.
 However, it's often best to assert that the target is equal to its expected value.
@@ -239,14 +239,14 @@ However, it's often best to assert that the target is equal to its expected valu
 **`Example`**
 
 ```ts
-   then(get.numberOfElements("radio")).shouldBeGreaterThen(5);
+   then(get.numberOfElements("radio")).shouldBeGreaterThan(5);
 ```
 
 ___
 
-### shouldBeGreaterThenOrEqual
+### shouldBeGreaterThanOrEqual
 
-▸ **shouldBeGreaterThenOrEqual**(`value`): `Chainable`<`T`\>
+▸ **shouldBeGreaterThanOrEqual**(`value`): `Chainable`<`T`\>
 
 Asserts that the target is a number or a date greater than or equal to the given number or date n respectively. However, it's often best to assert that the target is equal to its expected value.
 
@@ -263,14 +263,14 @@ Asserts that the target is a number or a date greater than or equal to the given
 **`Example`**
 
 ```ts
-  then(get.numberOfElements("radio")).shouldBeGreaterThenOrEqual(5);
+  then(get.numberOfElements("radio")).shouldBeGreaterThanOrEqual(5);
 ```
 
 ___
 
-### shouldBeLessThen
+### shouldBeLessThan
 
-▸ **shouldBeLessThen**(`value`): `Chainable`<`T`\>
+▸ **shouldBeLessThan**(`value`): `Chainable`<`T`\>
 
 Asserts that the target is a number or a n date less than or equal to the given number or date n respectively. However, it's often best to assert that the target is equal to its expected value.
 
@@ -292,9 +292,9 @@ Asserts that the target is a number or a n date less than or equal to the given
 
 ___
 
-### shouldBeLessThenOrEqual
+### shouldBeLessThanOrEqual
 
-▸ **shouldBeLessThenOrEqual**(`value`): `Chainable`<`T`\>
+▸ **shouldBeLessThanOrEqual**(`value`): `Chainable`<`T`\>
 
 Asserts that the target is a number or a date less than or equal to the given number or date n respectively.
 However, it's often best to assert that the target is equal to its expected value.
@@ -312,7 +312,7 @@ However, it's often best to assert that the target is equal to its expected valu
 **`Example`**
 
 ```ts
-then(get.numberOfElements('list-item')).shouldBeLessThenOrEqual(5)
+then(get.numberOfElements('list-item')).shouldBeLessThanOrEqual(5)
 ```
 
 ___
@@ -673,6 +673,21 @@ Assert spy was called with matching arguments (and possibly others).
 then(get.spy("onSomething")).shouldHaveBeenCalledWithMatch(match({ id: 1 }))
 ```
 
+**`Example`**
+
+```ts
+ it('should call the get method of the HTTP client with a URL with query param filter = status', () => {
+  healthService.fetchHealthResults(status);
+  then(get.mock.httpClientService().get).shouldHaveBeenCalledWith(
+    match(baseURL),
+    match.hasNested(
+      'params.updates[0]',
+      match({ param: 'filter', value: `status eq ${status}` })
+    )
+  );
+});
+```
+
 ___
 
 ### shouldHaveClass

diff --git a/documents/classes/CypressAngularComponentHelper.md b/documents/classes/CypressAngularComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v2.0.54](../README.md) / [Modules](../modules.md) / CypressAngularComponentHelper
+[@shellygo/cypress-test-utils - v2.0.56](../README.md) / [Modules](../modules.md) / CypressAngularComponentHelper
 
 # Class: CypressAngularComponentHelper<T\>
 

diff --git a/documents/classes/CypressHelper.md b/documents/classes/CypressHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v2.0.54](../README.md) / [Modules](../modules.md) / CypressHelper
+[@shellygo/cypress-test-utils - v2.0.56](../README.md) / [Modules](../modules.md) / CypressHelper
 
 # Class: CypressHelper
 

diff --git a/documents/classes/CypressHelperOptions.md b/documents/classes/CypressHelperOptions.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v2.0.54](../README.md) / [Modules](../modules.md) / CypressHelperOptions
+[@shellygo/cypress-test-utils - v2.0.56](../README.md) / [Modules](../modules.md) / CypressHelperOptions
 
 # Class: CypressHelperOptions
 

diff --git a/documents/classes/CypressLitComponentHelper.md b/documents/classes/CypressLitComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v2.0.54](../README.md) / [Modules](../modules.md) / CypressLitComponentHelper
+[@shellygo/cypress-test-utils - v2.0.56](../README.md) / [Modules](../modules.md) / CypressLitComponentHelper
 
 # Class: CypressLitComponentHelper
 

diff --git a/documents/classes/CypressReactComponentHelper.md b/documents/classes/CypressReactComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v2.0.54](../README.md) / [Modules](../modules.md) / CypressReactComponentHelper
+[@shellygo/cypress-test-utils - v2.0.56](../README.md) / [Modules](../modules.md) / CypressReactComponentHelper
 
 # Class: CypressReactComponentHelper
 

diff --git a/documents/modules.md b/documents/modules.md
@@ -1,6 +1,6 @@
-[@shellygo/cypress-test-utils - v2.0.54](README.md) / Modules
+[@shellygo/cypress-test-utils - v2.0.56](README.md) / Modules
 
-# @shellygo/cypress-test-utils - v2.0.54
+# @shellygo/cypress-test-utils - v2.0.56
 
 ## Table of contents
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@shellygo/cypress-test-utils",
   "description": "Cypress Test Automation Utilities",
-  "version": "2.0.55",
+  "version": "2.0.56",
   "author": "Shelly Goldblit",
   "private": false,
   "license": "MIT",

diff --git a/src/assertable.ts b/src/assertable.ts
@@ -334,6 +334,20 @@ export class Assertable<T> {
    * ```ts
    * then(get.spy("onSomething")).shouldHaveBeenCalledWithMatch(match({ id: 1 }))
    * ```
+   *
+   * @example
+   * ```ts
+   *  it('should call the get method of the HTTP client with a URL with query param filter = status', () => {
+   *   healthService.fetchHealthResults(status);
+   *   then(get.mock.httpClientService().get).shouldHaveBeenCalledWith(
+   *     match(baseURL),
+   *     match.hasNested(
+   *       'params.updates[0]',
+   *       match({ param: 'filter', value: `status eq ${status}` })
+   *     )
+   *   );
+   * });
+   * ```
    */
   public shouldHaveBeenCalledWithMatch = (...args: any[]) =>
     this.chainable.should("have.been.calledWithMatch", ...args);

diff --git a/src/cypress-helper.ts b/src/cypress-helper.ts
@@ -509,7 +509,6 @@ export class CypressHelper {
     type: (dataTestID: string, keys: string, index?: number) =>
       this.get
         .elementByTestId(dataTestID, index)
-        .focus()
         .type(keys, { parseSpecialCharSequences: false }),
 
     /**
@@ -520,7 +519,7 @@ export class CypressHelper {
      * ```
      */
     typeSpecialCharacter: (dataTestID: string, keys: string, index?: number) =>
-      this.get.elementByTestId(dataTestID, index).focus().type(keys),
+      this.get.elementByTestId(dataTestID, index).type(keys),
 
     /**
      * Runs a sequence of native press event (via cy.press) Type event is global. Make sure that it is not attached to any field.