pomwright 0.0.9 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # 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
+
+- 130784f: BREAKING: The following index.ts exports have been renamed:
+
+  - "POMWright" changed to "BasePage"
+  - "POMWrightTestFixture" changed to "test"
+  - "POMWrightLogger" changed to "PlaywrightReportLogger"
+  - "POMWrightGetLocatorBase" changed to "GetLocatorBase"
+  - "POMWrightApi" changed to "BaseApi"
+
+  Documentation updated
+
+  README updated
+
 ## 0.0.9
 
 ### Patch Changes

package/README.md

@@ -8,39 +8,105 @@ POMWright provides a way of abstracting the implementation details of a web page
 
 ## Features
 
-**Easy Creation of Page Object Classes:**
-Extend a class with POMwright to create a Page Object Class (POC).
+### Easy Creation of Page Object Classes
 
-**Support for Multiple Domains/BaseURLs:**
-Extend an abstract class with POMWright with a given BaseUrl, then create POCs for that BaseUrl by extending the abstract class.
+Simply extend a class with BasePage to create a Page Object Class (POC).
 
-**Custom Playwright Fixture Integration:** Create custom Playwright Fixtures from your POMWright POCs by extending test as POMWrightTestFixture.
+### Support for Multiple Domains/BaseURLs
 
-**LocatorSchema Interface:** Offers a way to define and structure comprehensive locators per POC and share common locators between them.
+Define different base URLs by extending an abstract class with BasePage per domain and have your POCs for each domain extend the abstract classes.
 
-**Advanced Locator Management:** Enables retrieval and automatic chaining of locators using LocatorSchemaPath.
+### Custom Playwright Fixture Integration
 
-**LocatorSchema Update/Updatess:** Allows updating single locators aswell as each locator a chained locator consist of, dynamically throughout a test.
+Seamlessly integrate custom Playwright Fixtures with your POMWright POCs.
 
-**Deep Copy of LocatorSchemas:** Ensures original LocatorSchemas are reusable in tests.
+### LocatorSchema Interface
 
-**Custom HTML Logger:** Provides detailed logs for nested locators, aiding in debugging and integration with Playwright's HTML report.
+Define comprehensive locators for each POC and share common locators between them.
 
-**SessionStorage Handling:** Includes methods for managing sessionStorage, complementing Playwright's capabilities.
+### Advanced Locator Management
+
+Efficiently manage and chain locators through LocatorSchemaPaths.
+
+### Dynamic Locator Schema Updates
+
+Modify single or multiple locators within a chained locator dynamically during tests.
+
+### Deep Copy of LocatorSchemas
+
+Ensure that original LocatorSchemas remain immutable and reusable across tests.
+
+### Custom HTML Logger
+
+Gain insights with detailed logs for nested locators, integrated with Playwright's HTML report. Or use the Log fixture throughout your own POCs and tests to easily attach them to the HTML report based on log levels.
+
+### SessionStorage Handling
+
+Enhance your tests with advanced sessionStorage handling capabilities.
 
 ## Installation
 
+Ensure you have Node.js installed, then run:
+
 ```bash
 npm install pomwright --save-dev
 ```
 
+or
+
+```bash
+pnpm i -D pomwright
+```
+
+## Playwright Example Project
+
+Explore POMWright in action by diving into the example project located in the "example" folder. Follow these steps to get started:
+
+### Install
+
+Navigate to the "example" folder and install the necessary dependencies:
+
+```bash
+pnpm install
+```
+
+### Playwright browsers
+
+Install or update Playwright browsers:
+
+```bash
+pnpm playwright install --with-deps
+```
+
+### Run tests
+
+Execute tests across chromium, firefox, and webkit:
+
+```bash
+pnpm playwright test
+```
+
+### Parallelism
+
+Control parallel test execution. By default, up to 4 tests run in parallel. Modify this setting as needed:
+
+```bash
+pnpm playwright test --workers 2  # Set the number of parallel workers
+```
+
+### Reports
+
+After the tests complete, a Playwright HTML report is available in ./example/playwright-report. Open the index.html file in your browser to view the results.
+
 ## Usage
 
-**Simple example of creating a Page Object Class:**
+Dive into using POMWright with these examples:
+
+### Create a Page Object Class (POC)
 
 ```TS
 import { Page, TestInfo } from "@playwright/test";
-import { POMWright, POMWrightLogger } from "pomwright";
+import { BasePage, PlaywrightReportLogger, GetByMethod } from "pomwright";
 
 type LocatorSchemaPath = 
   | "content"
@@ -48,8 +114,8 @@ type LocatorSchemaPath =
   | "content.region.details"
   | "content.region.details.button.edit";
 
-export default class Profile extends POMWright<LocatorSchemaPath> {
-  constructor(page: Page, testInfo: TestInfo, pwrl: POMWrightLogger) {
+export default class Profile extends BasePage<LocatorSchemaPath> {
+  constructor(page: Page, testInfo: TestInfo, pwrl: PlaywrightReportLogger) {
     super(page, testInfo, "https://someDomain.com", "/profile", Profile.name, pwrl);
   }
 
@@ -63,7 +129,7 @@ export default class Profile extends POMWright<LocatorSchemaPath> {
       role: "heading",
       roleOptions: {
         name: "Your Profile"
-      }
+      },
       locatorMethod: GetByMethod.role
     });
 
@@ -71,7 +137,7 @@ export default class Profile extends POMWright<LocatorSchemaPath> {
       role: "region",
       roleOptions: {
         name: "Profile Details"
-      }
+      },
       locatorMethod: GetByMethod.role
     });
 
@@ -79,7 +145,7 @@ export default class Profile extends POMWright<LocatorSchemaPath> {
       role: "button",
       roleOptions: {
         name: "Edit"
-      }
+      },
       locatorMethod: GetByMethod.role
     });
   }
@@ -88,10 +154,10 @@ export default class Profile extends POMWright<LocatorSchemaPath> {
 }
 ```
 
-**Creating a Custom Playwright Fixture for the Profile POC:**
+### Creating a Custom Playwright Fixture
 
 ```TS
-import { POMWrightTestFixture as base } from "pomwright";
+import { test as base } from "pomwright";
 import Profile from "...";
 
 type fixtures = {
@@ -106,7 +172,9 @@ export const test = base.extend<fixtures>({
 });
 ```
 
-**Using the fixture in a Playwright tests:**
+### Using the fixture in a Playwright tests
+
+#### Click edit button with a single locator
 
 ```TS
 import { test } from ".../fixtures";
@@ -126,6 +194,8 @@ test("click edit button with a single locator", async ({ profile }) => {
 });
 ```
 
+#### Click edit button with a nested locator
+
 ```TS
 import { test } from ".../fixtures";
 
@@ -147,6 +217,8 @@ test("click edit button with a nested locator", async ({ profile }) => {
 });
 ```
 
+#### Specify index for nested locator(s)
+
 ```TS
 import { test } from ".../fixtures";
 
@@ -170,6 +242,8 @@ test("specify index for nested locator(s)", async ({ profile }) => {
 });
 ```
 
+#### Update a locator before use
+
 ```TS
 import { test } from ".../fixtures";
 
@@ -193,6 +267,8 @@ test("update a locator before use", async ({ profile }) => {
 });
 ```
 
+#### Update a nested locator before use
+
 ```TS
 import { test } from ".../fixtures";
 
@@ -221,6 +297,8 @@ test("update a nested locator before use", async ({ profile }) => {
 });
 ```
 
+#### Make multiple versions of a locator
+
 ```TS
 import { test } from ".../fixtures";
 
@@ -246,3 +324,15 @@ test("make multiple versions of a locator", async ({ profile }) => {
 
 });
 ```
+
+## Troubleshooting and Support
+
+If you encounter any issues or have questions, please check our issues page or reach out to us directly.
+
+## Contributing
+
+Pull Requests are welcome!
+
+## License
+
+POMWright is open-source software licensed under the Apache-2.0 license

package/biome.json

@@ -1,15 +1,29 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.2.2/schema.json",
-  "organizeImports": {
-    "enabled": true
-  },
-  "linter": {
-    "enabled": true,
-    "rules": {
-      "recommended": true
-    }
-  },
-  "formatter": {
-    "formatWithErrors": true
-  }
-}
+	"$schema": "https://biomejs.dev/schemas/1.2.2/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"formatter": {
+		"enabled": true,
+		"formatWithErrors": true,
+		"indentStyle": "tab",
+		"indentWidth": 2,
+		"lineWidth": 120,
+		"ignore": []
+	},
+	"files": {
+		"ignore": [
+			"dist/**",
+			"node_modules/**",
+			"example/node_modules/**",
+			"example/playwright-report/**",
+			"example/test-results/**"
+		]
+	}
+}