pomwright 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # pomwright
 
+## 1.0.1
+
+### Patch Changes
+
+- [#23](https://github.com/DyHex/POMWright/pull/23) [`0cfc19f`](https://github.com/DyHex/POMWright/commit/0cfc19f057575365853f9df41bbd661bf45172e2) Thanks [@DyHex](https://github.com/DyHex)! - # Continuous testing & bug fixes
+
+  ## Bug fixes
+
+  - getLocatorBase.applyUpdate() now correctly updates the LocatorSchemaWithMethod and maintains a circular ref. for the entry representing itself in schemasMap
+  - getLocatorBase.applyUpdates() now correctly updates the LocatorSchemaWithMethod and maintains a circular ref. for the entry representing itself in schemasMap while updating other LocatorSchema in SchemasMap directly.
+  - getLocatorBase.deepMerge() now correctly validates valid nested properties of LocatorSchema
+
+  ## Continuous testing
+
+  - Build workflow now runs unit tests (vitest)
+  - New shell script enabling testing new packages before release
+  - New test workflow for POMWright integration tests (Playwright/test)
+  - 52 new unit tests, more to come..
+  - 4 new integration tests, more to come..
+
+  New release has also been tested with a seperate Playwright/test project leveraging POMWright (~100 E2E tests)
+
+  ## Playwright/test compatibility
+
+  Tested with the following Playwright/test versions:
+
+  - 1.43.1
+  - 1.43.0
+  - 1.42.1
+  - 1.42.0 (not recommended)
+  - 1.41.2
+  - 1.41.1
+  - 1.41.0
+  - 1.40.1
+  - 1.40.0
+  - 1.39.0
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -14,7 +14,7 @@ Simply extend a class with BasePage to create a Page Object Class (POC).
 
 ### Support for Multiple Domains/BaseURLs
 
-Define different base URLs by extending an abstract class with BasePage and have your POCs extend it.
+Define different base URLs by extending an abstract class with BasePage per domain and have your POCs for each domain extend the abstract classes.
 
 ### Custom Playwright Fixture Integration
 

package/biome.json

@@ -16,5 +16,14 @@
 		"indentWidth": 2,
 		"lineWidth": 120,
 		"ignore": []
+	},
+	"files": {
+		"ignore": [
+			"dist/**",
+			"node_modules/**",
+			"example/node_modules/**",
+			"example/playwright-report/**",
+			"example/test-results/**"
+		]
 	}
 }

package/dist/index.d.mts

@@ -104,7 +104,7 @@ interface LocatorSchema {
     /** Defines the preferred Playwright locator method to be used on this LocatorSchema Object */
     locatorMethod: GetByMethod;
     /** The human-readable name of the defined locator object, used for debug logging and test report enrichment. */
-    locatorSchemaPath: string;
+    readonly locatorSchemaPath: string;
 }
 
 type LogLevel = "debug" | "info" | "warn" | "error";
@@ -249,6 +249,7 @@ declare class GetLocatorBase<LocatorSchemaPathType extends string> {
      * It ensures that each locator schema and its sub-schemas are properly cloned and stored.
      */
     private collectDeepCopies;
+    private isLocatorSchemaWithMethods;
     /**
      * Applies an update to a specific locator schema within the provided map of schemas.
      * This method ensures that the specified updates are merged into the targeted locator schema.

package/dist/index.d.ts

@@ -104,7 +104,7 @@ interface LocatorSchema {
     /** Defines the preferred Playwright locator method to be used on this LocatorSchema Object */
     locatorMethod: GetByMethod;
     /** The human-readable name of the defined locator object, used for debug logging and test report enrichment. */
-    locatorSchemaPath: string;
+    readonly locatorSchemaPath: string;
 }
 
 type LogLevel = "debug" | "info" | "warn" | "error";
@@ -249,6 +249,7 @@ declare class GetLocatorBase<LocatorSchemaPathType extends string> {
      * It ensures that each locator schema and its sub-schemas are properly cloned and stored.
      */
     private collectDeepCopies;
+    private isLocatorSchemaWithMethods;
     /**
      * Applies an update to a specific locator schema within the provided map of schemas.
      * This method ensures that the specified updates are merged into the targeted locator schema.

package/dist/index.js

@@ -407,6 +407,15 @@ var GetBy = class {
 };
 
 // src/helpers/getLocatorBase.ts
+var REQUIRED_PROPERTIES_FOR_LOCATOR_SCHEMA_WITH_METHODS = [
+  "update",
+  "updates",
+  "getNestedLocator",
+  "getLocator",
+  "locatorSchemaPath",
+  "locatorMethod",
+  "schemasMap"
+];
 var GetLocatorBase = class {
   /**
    * Initializes the GetLocatorBase class with a page object class and a logger.
@@ -467,6 +476,9 @@ var GetLocatorBase = class {
     }
     return schemasMap;
   }
+  isLocatorSchemaWithMethods(schema) {
+    return REQUIRED_PROPERTIES_FOR_LOCATOR_SCHEMA_WITH_METHODS.every((p) => p in schema);
+  }
   /**
    * Applies an update to a specific locator schema within the provided map of schemas.
    * This method ensures that the specified updates are merged into the targeted locator schema.
@@ -474,7 +486,12 @@ var GetLocatorBase = class {
   applyUpdate(schemasMap, locatorSchemaPath, updateData) {
     const schema = schemasMap.get(locatorSchemaPath);
     if (schema) {
-      schemasMap.set(locatorSchemaPath, this.deepMerge(schema, updateData));
+      const updatedSchema = this.deepMerge(schema, updateData);
+      if (this.isLocatorSchemaWithMethods(schema)) {
+        Object.assign(schema, updatedSchema);
+      } else {
+        throw new Error("Invalid LocatorSchema object provided for update method.");
+      }
     }
   }
   /**
@@ -487,7 +504,12 @@ var GetLocatorBase = class {
       if (path && updateAtIndex) {
         const schema = schemasMap.get(path);
         if (schema) {
-          schemasMap.set(path, this.deepMerge(schema, updateAtIndex));
+          const updatedSchema = this.deepMerge(schema, updateAtIndex);
+          if (this.isLocatorSchemaWithMethods(schema)) {
+            Object.assign(schema, updatedSchema);
+          } else {
+            schemasMap.set(path, updatedSchema);
+          }
         }
       }
     }
@@ -564,29 +586,45 @@ Attempted to Add Schema: ${JSON.stringify(newLocatorSchema, null, 2)}`
     throw error;
   };
   /** Merges 'source' into 'target', combining their properties into a new isolated object. */
-  deepMerge(target, source) {
+  deepMerge(target, source, schema = getLocatorSchemaDummy()) {
     const merged = { ...target };
-    const dummySchema = getLocatorSchemaDummy();
-    if (typeof source === "object" && source !== null) {
-      const filteredKeys = Object.keys(source).filter((key) => key !== "locatorSchemaPath");
-      for (const key of filteredKeys) {
-        const targetKey = key;
-        const sourceKey = key;
-        if (!(key in dummySchema)) {
-          throw new Error(`Invalid property: '${key}' is not a valid property of LocatorSchema`);
+    for (const key of Object.keys(source)) {
+      if (key === "locatorSchemaPath") {
+        throw new Error(
+          `[${this.pageObjectClass.pocName}] Invalid property: 'locatorSchemaPath' cannot be updated. Attempted to update LocatorSchemaPath from '${target[key]}' to '${source[key]}'.`
+        );
+      }
+      if (!(key in schema)) {
+        throw new Error(`Invalid property: '${key}' is not a valid property of LocatorSchema`);
+      }
+      const sourceValue = source[key];
+      const targetValue = target[key];
+      if (typeof sourceValue === "object" && sourceValue !== null && schema[key] && typeof schema[key] === "object") {
+        if (targetValue && typeof targetValue === "object" && !Array.isArray(targetValue)) {
+          merged[key] = this.deepMerge(
+            targetValue,
+            // Updated type here
+            sourceValue,
+            schema[key]
+          );
+        } else {
+          merged[key] = this.deepMerge(
+            {},
+            // Updated type here
+            sourceValue,
+            schema[key]
+          );
         }
-        const targetValue = merged[targetKey];
-        const sourceValue = source[sourceKey];
-        if (sourceValue !== void 0) {
-          if (Array.isArray(targetValue) && Array.isArray(sourceValue)) {
-            merged[targetKey] = [...targetValue, ...sourceValue];
-          } else if (sourceValue instanceof RegExp) {
-            merged[targetKey] = new RegExp(sourceValue.source, sourceValue.flags);
-          } else if (typeof sourceValue === "object" && sourceValue !== null) {
-            merged[targetKey] = targetValue ? this.deepMerge(targetValue, sourceValue) : structuredClone(sourceValue);
-          } else {
-            merged[targetKey] = sourceValue;
-          }
+      } else {
+        if (Array.isArray(sourceValue)) {
+          merged[key] = Array.isArray(targetValue) ? targetValue.concat(sourceValue) : [...sourceValue];
+        } else if (typeof sourceValue === "object" && sourceValue !== null && Object.prototype.toString.call(sourceValue) === "[object RegExp]") {
+          merged[key] = new RegExp(
+            sourceValue.source,
+            sourceValue.flags
+          );
+        } else {
+          merged[key] = sourceValue;
         }
       }
     }

package/dist/index.mjs

@@ -376,6 +376,15 @@ var GetBy = class {
 };
 
 // src/helpers/getLocatorBase.ts
+var REQUIRED_PROPERTIES_FOR_LOCATOR_SCHEMA_WITH_METHODS = [
+  "update",
+  "updates",
+  "getNestedLocator",
+  "getLocator",
+  "locatorSchemaPath",
+  "locatorMethod",
+  "schemasMap"
+];
 var GetLocatorBase = class {
   /**
    * Initializes the GetLocatorBase class with a page object class and a logger.
@@ -436,6 +445,9 @@ var GetLocatorBase = class {
     }
     return schemasMap;
   }
+  isLocatorSchemaWithMethods(schema) {
+    return REQUIRED_PROPERTIES_FOR_LOCATOR_SCHEMA_WITH_METHODS.every((p) => p in schema);
+  }
   /**
    * Applies an update to a specific locator schema within the provided map of schemas.
    * This method ensures that the specified updates are merged into the targeted locator schema.
@@ -443,7 +455,12 @@ var GetLocatorBase = class {
   applyUpdate(schemasMap, locatorSchemaPath, updateData) {
     const schema = schemasMap.get(locatorSchemaPath);
     if (schema) {
-      schemasMap.set(locatorSchemaPath, this.deepMerge(schema, updateData));
+      const updatedSchema = this.deepMerge(schema, updateData);
+      if (this.isLocatorSchemaWithMethods(schema)) {
+        Object.assign(schema, updatedSchema);
+      } else {
+        throw new Error("Invalid LocatorSchema object provided for update method.");
+      }
     }
   }
   /**
@@ -456,7 +473,12 @@ var GetLocatorBase = class {
       if (path && updateAtIndex) {
         const schema = schemasMap.get(path);
         if (schema) {
-          schemasMap.set(path, this.deepMerge(schema, updateAtIndex));
+          const updatedSchema = this.deepMerge(schema, updateAtIndex);
+          if (this.isLocatorSchemaWithMethods(schema)) {
+            Object.assign(schema, updatedSchema);
+          } else {
+            schemasMap.set(path, updatedSchema);
+          }
         }
       }
     }
@@ -533,29 +555,45 @@ Attempted to Add Schema: ${JSON.stringify(newLocatorSchema, null, 2)}`
     throw error;
   };
   /** Merges 'source' into 'target', combining their properties into a new isolated object. */
-  deepMerge(target, source) {
+  deepMerge(target, source, schema = getLocatorSchemaDummy()) {
     const merged = { ...target };
-    const dummySchema = getLocatorSchemaDummy();
-    if (typeof source === "object" && source !== null) {
-      const filteredKeys = Object.keys(source).filter((key) => key !== "locatorSchemaPath");
-      for (const key of filteredKeys) {
-        const targetKey = key;
-        const sourceKey = key;
-        if (!(key in dummySchema)) {
-          throw new Error(`Invalid property: '${key}' is not a valid property of LocatorSchema`);
+    for (const key of Object.keys(source)) {
+      if (key === "locatorSchemaPath") {
+        throw new Error(
+          `[${this.pageObjectClass.pocName}] Invalid property: 'locatorSchemaPath' cannot be updated. Attempted to update LocatorSchemaPath from '${target[key]}' to '${source[key]}'.`
+        );
+      }
+      if (!(key in schema)) {
+        throw new Error(`Invalid property: '${key}' is not a valid property of LocatorSchema`);
+      }
+      const sourceValue = source[key];
+      const targetValue = target[key];
+      if (typeof sourceValue === "object" && sourceValue !== null && schema[key] && typeof schema[key] === "object") {
+        if (targetValue && typeof targetValue === "object" && !Array.isArray(targetValue)) {
+          merged[key] = this.deepMerge(
+            targetValue,
+            // Updated type here
+            sourceValue,
+            schema[key]
+          );
+        } else {
+          merged[key] = this.deepMerge(
+            {},
+            // Updated type here
+            sourceValue,
+            schema[key]
+          );
         }
-        const targetValue = merged[targetKey];
-        const sourceValue = source[sourceKey];
-        if (sourceValue !== void 0) {
-          if (Array.isArray(targetValue) && Array.isArray(sourceValue)) {
-            merged[targetKey] = [...targetValue, ...sourceValue];
-          } else if (sourceValue instanceof RegExp) {
-            merged[targetKey] = new RegExp(sourceValue.source, sourceValue.flags);
-          } else if (typeof sourceValue === "object" && sourceValue !== null) {
-            merged[targetKey] = targetValue ? this.deepMerge(targetValue, sourceValue) : structuredClone(sourceValue);
-          } else {
-            merged[targetKey] = sourceValue;
-          }
+      } else {
+        if (Array.isArray(sourceValue)) {
+          merged[key] = Array.isArray(targetValue) ? targetValue.concat(sourceValue) : [...sourceValue];
+        } else if (typeof sourceValue === "object" && sourceValue !== null && Object.prototype.toString.call(sourceValue) === "[object RegExp]") {
+          merged[key] = new RegExp(
+            sourceValue.source,
+            sourceValue.flags
+          );
+        } else {
+          merged[key] = sourceValue;
         }
       }
     }

package/index.ts

@@ -7,7 +7,7 @@ export { test };
 import { PlaywrightReportLogger } from "./src/helpers/playwrightReportLogger";
 export { PlaywrightReportLogger };
 
-import { GetByMethod, type LocatorSchema, type AriaRoleType } from "./src/helpers/locatorSchema.interface";
+import { type AriaRoleType, GetByMethod, type LocatorSchema } from "./src/helpers/locatorSchema.interface";
 export { GetByMethod, type LocatorSchema, type AriaRoleType };
 
 import { GetLocatorBase } from "./src/helpers/getLocatorBase";

package/pack-test.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+TEST_DIR="test"
+
+# Function to revert to the latest published version, ensuring it's executed in the ./$TEST_DIR directory
+cleanup() {
+    # Check if the current directory is ./test, if not, try to change to it
+    if [[ $(basename "$PWD") != "$TEST_DIR" ]]; then
+        echo "Not in ./$TEST_DIR directory. Trying to change to ./$TEST_DIR directory..."
+        if [[ -d "$TEST_DIR" ]]; then
+            cd $TEST_DIR || { echo "Failed to change to ./$TEST_DIR directory"; return 1; }
+        else
+            echo "The ./$TEST_DIR directory does not exist. Exiting cleanup."
+            return 1
+        fi
+    fi
+
+    echo "Reverting to latest published version of POMWright in the ./$TEST_DIR directory..."
+    pnpm i -D pomwright@latest || { echo "Failed to revert to latest POMWright version"; exit 1; }
+}
+
+# Trap statement that calls cleanup function on exit
+trap cleanup EXIT
+
+# Stop the script if any command fails
+set -e
+
+# Extract version from package.json
+VERSION=$(node -pe "require('./package.json').version")
+
+# Install, Build & Pack
+pnpm i --frozen-lockfile || { echo "Installation failed"; exit 1; }
+pnpm build || { echo "Build failed"; exit 1; }
+pnpm pack || { echo "Packaging failed"; exit 1; }
+
+# Move to the test directory
+cd $TEST_DIR || { echo "Changing directory failed"; exit 1; }
+
+# Install the local package
+pnpm i -D ../pomwright-$VERSION.tgz || { echo "Local package installation failed"; exit 1; }
+
+# Install dependencies and run playwright tests
+pnpm i --frozen-lockfile || { echo "Installation failed"; exit 1; }
+pnpm playwright install --with-deps || { echo "Playwright dependencies installation failed"; exit 1; }
+pnpm playwright test || { echo "Tests failed"; exit 1; }
+
+echo "Testing completed successfully."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pomwright",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "POMWright is a complementary test framework for Playwright written in TypeScript.",
   "repository": {
     "type": "git",
@@ -24,20 +24,24 @@
     "Test Framework"
   ],
   "devDependencies": {
-    "@biomejs/biome": "^1.5.1",
+    "@biomejs/biome": "^1.5.3",
+    "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.1",
     "@types/node": "^20.10.8",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "^1.5.0"
   },
   "peerDependencies": {
-    "@playwright/test": "^1.40.1"
+    "@playwright/test": "^1.39.0"
   },
   "scripts": {
     "build": "tsup index.ts --format cjs,esm --dts",
     "release": "pnpm run build && changeset publish",
     "lint": "biome check ./src",
     "format": "biome format ./src --write",
-    "install-browsers": "playwright install --with-deps"
+    "install-browsers": "playwright install --with-deps",
+    "pack-test": "bash pack-test.sh",
+    "test": "vitest run && bash pack-test.sh"
   }
 }

package/vitest.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+	test: {
+		globals: true,
+		environment: "node",
+		dir: "src",
+	},
+});

package/.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-  "recommendations": [
-    "biomejs.biome"
-  ]
-}

package/.vscode/playwright-snippets.code-snippets

@@ -1,82 +0,0 @@
-{
-    "Playwright Import": {
-      "prefix": "pw-import",
-      "body": [
-        "import { test, expect } from \"@fixtures/$1\";"
-      ],
-      "description": "Import Playwright Test through our Fixtures"
-    },
-    "Playwright Describe": {
-      "prefix": "pw-describe",
-      "body": [
-        "test.describe(\"$1\", () => {",
-        "  $2",
-        "});"
-      ],
-      "description": "Playwright Test describe block"
-    },
-    "Playwright Test": {
-      "prefix": "pw-test",
-      "body": [
-        "test(\"$1\", async ({ $2 }) => {",
-        "  $3",
-        "});"
-      ],
-      "description": "Playwright Test test block"
-    },
-    "Playwright Step": {
-      "prefix": "pw-step",
-      "body": [
-        "await test.step(`${$1.pocName}: $2`, async () => {",
-        "  $3",
-        "});"
-      ],
-      "description": "Playwright Test step block"
-    },
-    "Playwright Use": {
-      "prefix": "pw-use",
-      "body": [
-        "test.use({",
-        "  $1",
-        "});"
-      ],
-      "description": "Playwright Test use block"
-    },
-    "Playwright beforeEach": {
-      "prefix": "pw-beforeEach",
-      "body": [
-        "test.beforeEach(async ({ $1 }) => {",
-        "  $2",
-        "});"
-      ],
-      "description": "Playwright Test beforeEach block"
-    },
-    "Playwright afterEach": {
-      "prefix": "pw-afterEach",
-      "body": [
-        "test.afterEach(async ({ $1 }) => {",
-        "  $2",
-        "});"
-      ],
-      "description": "Playwright Test afterEach block"
-    },
-    "Playwright beforeAll": {
-      "prefix": "pw-beforeAll",
-      "body": [
-        "test.beforeAll(async ({ $1 }) => {",
-        "  $2",
-        "});"
-      ],
-      "description": "Playwright Test beforeAll block"
-    },
-    "Playwright afterAll": {
-      "prefix": "pw-afterAll",
-      "body": [
-        "test.afterAll(async ({ $1 }) => {",
-        "  $2",
-        "});"
-      ],
-      "description": "Playwright Test afterAll block"
-    }
-  }
-  

package/.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-	"editor.defaultFormatter": "biomejs.biome",
-	"editor.formatOnSave": true
-}

package/example/.env

@@ -1 +0,0 @@
-BASE_URL_SAUCEDEMO="https://www.saucedemo.com"

package/example/fixtures/all.fixtures.ts

@@ -1,4 +0,0 @@
-import { mergeTests } from "@playwright/test";
-import { test as saucedemoTest } from "../page-object-models/saucedemo/fixtures/saucedemo.fixtures";
-
-export const test = mergeTests(saucedemoTest);

package/example/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "example",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {},
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@playwright/test": "^1.40.1",
-    "@types/node": "^20.11.1",
-    "pomwright": "^0.0.9"
-  },
-  "dependencies": {
-    "dotenv": "^16.3.1"
-  }
-}

package/example/page-object-models/saucedemo/common/base-page/saucedemo.page.ts

@@ -1,28 +0,0 @@
-import { type Page, type TestInfo } from "@playwright/test";
-import { POMWright, POMWrightLogger } from "pomwright";
-
-export type UserCredentials = { username: string; password: string };
-
-export default abstract class Saucedemo<LocatorSchemaPathType extends string> extends POMWright<LocatorSchemaPathType> {
-	constructor(page: Page, testInfo: TestInfo, urlPath: string, pocName: string, pwrl: POMWrightLogger) {
-		super(page, testInfo, process.env.BASE_URL_SAUCEDEMO || "", urlPath, pocName, pwrl);
-	}
-
-	getTestData() {
-		const passordForAllUsers = "secret_sauce";
-		return {
-			user: {
-				standard: {
-					username: "standard_user",
-					password: passordForAllUsers,
-				} as UserCredentials,
-				lockedOut: {
-					username: "locked_out_user",
-					password: passordForAllUsers,
-				} as UserCredentials,
-			},
-		};
-	}
-
-	// add your common helper methods here...
-}

package/example/page-object-models/saucedemo/common/page-components/common.locatorScema.ts

@@ -1,11 +0,0 @@
-import { POMWrightGetLocatorBase } from "pomwright";
-import {
-	type LocatorSchemaPath as headerMenu,
-	initLocatorSchemas as initHeaderMenu,
-} from "./headerMenu/headerMenu.locatorSchema";
-
-export type LocatorSchemaPath = headerMenu;
-
-export function initLocatorSchemas(locators: POMWrightGetLocatorBase<LocatorSchemaPath>) {
-	initHeaderMenu(locators);
-}

package/example/page-object-models/saucedemo/common/page-components/headerMenu/headerMenu.locatorSchema.ts

@@ -1,45 +0,0 @@
-import { GetByMethod, POMWrightGetLocatorBase } from "pomwright";
-
-export type LocatorSchemaPath =
-	| "common.headerMenu"
-	| "common.headerMenu.button.burger"
-	| "common.sidebar"
-	| "common.sidebar.menu"
-	| "common.sidebar.menu.link.logout";
-
-export function initLocatorSchemas(locators: POMWrightGetLocatorBase<LocatorSchemaPath>) {
-	locators.addSchema("common.headerMenu", {
-		locator: ".primary_header",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("common.headerMenu.button.burger", {
-		role: "button",
-		roleOptions: {
-			name: "Open Menu",
-		},
-		id: "react-burger-menu-btn",
-		locatorMethod: GetByMethod.role,
-	});
-
-	locators.addSchema("common.sidebar", {
-		locator: ".bm-menu-wrap",
-		id: "",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("common.sidebar.menu", {
-		locator: ".bm-menu",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("common.sidebar.menu.link.logout", {
-		role: "link",
-		roleOptions: {
-			name: "Logout",
-		},
-		text: "Logout",
-		id: "logout_sidebar_link",
-		locatorMethod: GetByMethod.text,
-	});
-}

package/example/page-object-models/saucedemo/fixtures/saucedemo.fixtures.ts

@@ -1,20 +0,0 @@
-import { POMWrightTestFixture as base } from "pomwright";
-import Home from "../pages/home.page";
-import Inventory from "../pages/inventory/inventory.page";
-
-type fixtures = {
-	sdHome: Home;
-	sdInventory: Inventory;
-};
-
-export const test = base.extend<fixtures>({
-	sdHome: async ({ page, log }, use, testInfo) => {
-		const sdHome = new Home(page, testInfo, log);
-		await use(sdHome);
-	},
-
-	sdInventory: async ({ page, log }, use, testInfo) => {
-		const sdInventory = new Inventory(page, testInfo, log);
-		await use(sdInventory);
-	},
-});

package/example/page-object-models/saucedemo/pages/home.locatorSchema.ts

@@ -1,99 +0,0 @@
-import { GetByMethod, POMWrightGetLocatorBase } from "pomwright";
-
-export type LocatorSchemaPath =
-	| "content"
-	| "content.heading"
-	| "content.region.login"
-	| "content.region.login.form"
-	| "content.region.login.form.input.username"
-	| "content.region.login.form.input.password"
-	| "content.region.login.form.error"
-	| "content.region.login.form.error.lockout"
-	| "content.region.login.form.button.login"
-	| "content.region.credentials"
-	| "content.region.credentials.usernames"
-	| "content.region.credentials.passwords";
-
-export function initLocatorSchemas(locators: POMWrightGetLocatorBase<LocatorSchemaPath>) {
-	locators.addSchema("content", {
-		locator: ".login_container",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("content.heading", {
-		locator: ".login_logo",
-		text: "Swag Labs",
-		locatorMethod: GetByMethod.text,
-	});
-
-	locators.addSchema("content.region.login", {
-		locator: ".login_wrapper",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("content.region.login.form", {
-		locator: "form",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("content.region.login.form.input.username", {
-		role: "textbox",
-		roleOptions: {
-			name: "Username",
-		},
-		placeholder: "Username",
-		placeholderOptions: {
-			exact: true,
-		},
-		id: "user-name",
-		locatorMethod: GetByMethod.role,
-	});
-
-	locators.addSchema("content.region.login.form.input.password", {
-		role: "textbox",
-		roleOptions: {
-			name: "Password",
-		},
-		placeholder: "Password",
-		placeholderOptions: {
-			exact: true,
-		},
-		id: "password",
-		locatorMethod: GetByMethod.role,
-	});
-
-	locators.addSchema("content.region.login.form.error", {
-		locator: ".error-message-container",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("content.region.login.form.error.lockout", {
-		text: "Epic sadface: Sorry, this user has been locked out.",
-		locatorMethod: GetByMethod.text,
-	});
-
-	locators.addSchema("content.region.login.form.button.login", {
-		role: "button",
-		roleOptions: {
-			name: "Login",
-		},
-		id: "login-button",
-		locatorMethod: GetByMethod.role,
-	});
-
-	locators.addSchema("content.region.credentials", {
-		locator: ".login_credentials_wrap",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("content.region.credentials.usernames", {
-		locator: ".login_credentials",
-		id: "login_credentials",
-		locatorMethod: GetByMethod.locator,
-	});
-
-	locators.addSchema("content.region.credentials.passwords", {
-		locator: ".login_password",
-		locatorMethod: GetByMethod.locator,
-	});
-}

package/example/page-object-models/saucedemo/pages/home.page.ts

@@ -1,29 +0,0 @@
-import test, { type Page, type TestInfo } from "@playwright/test";
-import { POMWrightLogger } from "pomwright";
-import Saucedemo, { type UserCredentials } from "../common/base-page/saucedemo.page";
-import { type LocatorSchemaPath, initLocatorSchemas } from "./home.locatorSchema";
-
-export default class Home extends Saucedemo<LocatorSchemaPath> {
-	constructor(page: Page, testInfo: TestInfo, pwrl: POMWrightLogger) {
-		super(page, testInfo, "/", Home.name, pwrl);
-	}
-
-	protected initLocatorSchemas() {
-		initLocatorSchemas(this.locators);
-	}
-
-	async fillLoginForm(userCredentials: UserCredentials) {
-		await test.step(`${this.pocName}: Fill user login credentials and login`, async () => {
-			const username = await this.getNestedLocator("content.region.login.form.input.username");
-			await username.fill(userCredentials.username);
-
-			const password = await this.getNestedLocator("content.region.login.form.input.password");
-			await password.fill(userCredentials.password);
-
-			const loginButton = await this.getNestedLocator("content.region.login.form.button.login");
-			await loginButton.click();
-		});
-	}
-
-	// add your helper methods here...
-}

package/example/page-object-models/saucedemo/pages/inventory/inventory.locatorSchema.ts

@@ -1,22 +0,0 @@
-import { GetByMethod, POMWrightGetLocatorBase } from "pomwright";
-import {
-	type LocatorSchemaPath as commmon,
-	initLocatorSchemas as initCommon,
-} from "../../common/page-components/headerMenu/headerMenu.locatorSchema";
-
-export type LocatorSchemaPath = commmon | "inventory" | "inventory.container" | "inventory.container.list";
-
-export function initLocatorSchemas(locators: POMWrightGetLocatorBase<LocatorSchemaPath>) {
-	initCommon(locators);
-
-	locators.addSchema("inventory", {
-		id: "inventory_container", // duplicate, will resolve to multiple locators
-		locatorMethod: GetByMethod.id,
-	});
-
-	locators.addSchema("inventory.container", {
-		locator: ".inventory_container",
-		id: "inventory_container", // duplicate, will resolve to multiple locators
-		locatorMethod: GetByMethod.locator,
-	});
-}

package/example/page-object-models/saucedemo/pages/inventory/inventory.page.ts

@@ -1,26 +0,0 @@
-import test, { type Page, type TestInfo } from "@playwright/test";
-import { POMWrightLogger } from "pomwright";
-import Saucedemo from "../../common/base-page/saucedemo.page";
-import { type LocatorSchemaPath, initLocatorSchemas } from "./inventory.locatorSchema";
-
-export default class Inventory extends Saucedemo<LocatorSchemaPath> {
-	constructor(page: Page, testInfo: TestInfo, pwrl: POMWrightLogger) {
-		super(page, testInfo, "/inventory.html", Inventory.name, pwrl);
-	}
-
-	protected initLocatorSchemas() {
-		initLocatorSchemas(this.locators);
-	}
-
-	async logout() {
-		await test.step(`${this.pocName}: Logout user from inventory page`, async () => {
-			const burgerMenyBtn = await this.getNestedLocator("common.headerMenu.button.burger");
-			await burgerMenyBtn.click();
-
-			const logoutLink = await this.getNestedLocator("common.sidebar.menu.link.logout");
-			await logoutLink.click();
-		});
-	}
-
-	// add your helper methods here...
-}

package/example/playwright.config.ts

@@ -1,63 +0,0 @@
-import { defineConfig, devices } from "@playwright/test";
-import dotenv from "dotenv";
-
-// Environment variables ./.env
-dotenv.config({ override: false });
-
-/**
- * See https://playwright.dev/docs/test-configuration.
- */
-export default defineConfig({
-	testDir: "./tests",
-	globalTimeout: 60_000 * 30,
-	timeout: 60_000 * 2,
-	expect: {
-		timeout: 10_000,
-	},
-	fullyParallel: true,
-	forbidOnly: !!process.env.CI,
-	retries: process.env.CI ? 2 : 1,
-	workers: process.env.CI ? "50%" : 4,
-	reporter: process.env.CI
-		? [
-				["html", { open: "never" }],
-				["github", { printSteps: false }],
-		  ]
-		: [
-				["html", { open: "on-failure" }],
-				["list", { printSteps: false }],
-		  ],
-	use: {
-		actionTimeout: 10_000,
-		navigationTimeout: 30_000,
-		headless: true,
-		viewport: { width: 1280, height: 720 },
-		ignoreHTTPSErrors: false,
-		video: "retry-with-video", // system taxing
-		screenshot: { mode: "only-on-failure", fullPage: true, omitBackground: false },
-		trace: "on-all-retries", // system taxing
-		testIdAttribute: "data-testid", // Playwright default
-		// locale: "nb-NO",
-		// baseURL: process.env.BASE_URL // we do not want to use this if we want to test multiple-domains, make an abstract class per domain extending POMWright instead
-	},
-
-	/* Configure projects for major browsers */
-	projects: [
-		{
-			name: "chromium",
-			use: { ...devices["Desktop Chrome"] },
-		},
-
-		{
-			name: "firefox",
-			use: { ...devices["Desktop Firefox"] },
-		},
-
-		{
-			name: "webkit",
-			use: { ...devices["Desktop Safari"] },
-		},
-	],
-
-	// webServer: []
-});