Added capability to provide _defaultResolver_ to define default logic to identify element (#151)

Author: AlexGalichenko

CHANGELOG.md

@@ -24,6 +24,16 @@ Breaking change:
     When I click 'Alert Button'
     And I accept dialog
 ```
+
+- Added capability to provide _defaultResolver_ to define default logic to identify element
+```typescript
+class App {
+    defaultResolver({ alias }: { alias: string }) {
+      return ({ parent }: { parent: Locator }) => parent.getByText(alias);
+    }
+}
+```
+
 - :chore: updated playwright dependency
 
 ## [2.4.0]

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/steps-playwright",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "steps to interact with playwright",
   "main": "./index.js",
   "scripts": {
@@ -33,17 +33,17 @@
     "@qavajs/memory": "^1.10.2",
     "@qavajs/webstorm-adapter": "^8.0.0",
     "@types/chai": "^4.3.20",
-    "@types/express": "^5.0.0",
-    "@vitest/coverage-v8": "^3.0.8",
-    "@vitest/ui": "^3.0.8",
-    "electron": "^35.0.1",
-    "express": "^5.0.0",
+    "@types/express": "^5.0.1",
+    "@vitest/coverage-v8": "^3.1.1",
+    "@vitest/ui": "^3.1.1",
+    "electron": "^35.1.5",
+    "express": "^5.1.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.8",
-    "@qavajs/validation": "^1.1.0"
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1",
+    "@qavajs/validation": "^1.1.1"
   },
   "dependencies": {
-    "@playwright/test": "^1.51.0"
+    "@playwright/test": "^1.51.1"
   }
 }

package.json

@@ -98,8 +98,15 @@ export function query(root: any, path: string) {
     for (const element of elements) {
         const groups = element.match(/^(?<alias>.+?)(?:\((?<argument>.+)\))?$/)?.groups as { alias: string, argument: string };
         const alias = groups.alias.replace(/\s/g, '');
-        const currentElement = currentComponent[alias];
-        if (!currentElement) throw new Error(`Alias '${alias}' has not been found in '${currentAlias}'`);
+        let currentElement = currentComponent[alias];
+        if (!currentElement && (!currentComponent.defaultResolver || typeof currentComponent.defaultResolver !== 'function')) {
+            throw new Error(`Alias '${alias}' has not been found in '${currentAlias}'`);
+        }
+        if (!currentElement && currentComponent.defaultResolver) {
+            currentElement = {};
+            currentElement.selector = currentComponent.defaultResolver({ alias: groups.alias, argument: groups.argument });
+            currentElement.type = 'native';
+        }
         currentAlias = groups.alias;
         currentComponent = currentElement.component ? new currentElement.component() : null;
 

src/pageObject.ts

@@ -1,4 +1,3 @@
-@debug
 Feature: dialog
 
   Background:

test-e2e/features/dialog.feature

@@ -23,4 +23,7 @@ Feature: page object
     Then I expect text of 'Simple Text Element Template ({$selector})' to be equal 'text value'
 
   Scenario: top level component
-    Then I expect text of 'Top Level Component > Text Element' to be equal 'text value'
+    Then I expect text of 'Top Level Component > Text Element' to be equal 'text value'
+
+  Scenario: default resolver
+    Then I expect text of 'third value' to be equal 'third value'

test-e2e/features/pageObject.feature

@@ -1,4 +1,6 @@
 import { locator } from '../../po';
+import { Locator } from '@playwright/test';
+
 export default class App {
     SimpleTextElement = locator('#textValue');
     SimpleTextElementTemplate = locator.template(selector => selector);
@@ -79,6 +81,10 @@ export default class App {
     SimpleTextListItemsByJS = locator('js=document.querySelectorAll("#textValueList li")');
 
     TopLevelComponent = locator.as(BodyComponent);
+
+    defaultResolver({ alias }: { alias: string }) {
+        return ({ parent }: { parent: Locator }) => parent.getByText(alias);
+    }
 }
 
 class BodyComponent {