pw-core 1.2.1 → 1.3.1

package/dist/page/registry.js

@@ -7,9 +7,36 @@ exports.createPageRegistry = createPageRegistry;
 const test_1 = __importDefault(require("@playwright/test"));
 const typed_page_1 = require("./typed-page");
 const resolver_1 = require("./locators/resolver");
-function createPageRegistryWithClasses(registry, classes, base) {
+// Local runtime key transformation helpers for fixture aliases.
+// Intentionally kept local to preserve runtime isolation (page/ does not depend on codegen/).
+function toUnprefixedPageKey(key) {
+    return key.slice(6).charAt(0).toLowerCase() + key.slice(7);
+}
+function toWorkerPageKey(key) {
+    return key.startsWith('worker') ? key : `worker${key.charAt(0).toUpperCase()}${key.slice(1)}`;
+}
+function getPageKeyAliases(key) {
+    if (key.startsWith('worker')) {
+        const unprefixed = toUnprefixedPageKey(key);
+        return { pageKey: unprefixed || key, workerKey: key };
+    }
+    return { pageKey: key, workerKey: toWorkerPageKey(key) };
+}
+function createPageFixture(PageClass) {
+    return async ({ page }, use) => {
+        await use(new PageClass(page));
+    };
+}
+function createWorkerFixture(PageClass) {
+    return [
+        async ({ workerPage }, use) => {
+            await use(new PageClass(workerPage));
+        },
+        { scope: 'worker' }
+    ];
+}
+function createRegistryFixtures(registry, classes) {
     const fixtures = {
-        // Shared worker context and page
         workerContext: [
             async ({ browser }, use) => {
                 const context = await browser.newContext();
@@ -20,82 +47,59 @@ function createPageRegistryWithClasses(registry, classes, base) {
         ],
         workerPage: [
             async ({ workerContext }, use) => {
-                const page = await workerContext.newPage();
-                await use(page);
+                await use(await workerContext.newPage());
             },
             { scope: 'worker' }
         ]
     };
     for (const key of Object.keys(registry)) {
-        // Page fixture for key
-        fixtures[key] = async ({ page }, use) => {
-            const PageClass = classes[key];
-            const instance = new PageClass(page);
-            await use(instance);
-        };
-        // Page fixture for un-prefixed key (if key starts with worker)
-        if (key.startsWith('worker')) {
-            const unPrefixed = key.slice(6).charAt(0).toLowerCase() + key.slice(7);
-            if (unPrefixed && !fixtures[unPrefixed]) {
-                fixtures[unPrefixed] = async ({ page }, use) => {
-                    const PageClass = classes[key];
-                    const instance = new PageClass(page);
-                    await use(instance);
-                };
-            }
-        }
-        // Worker fixture for worker-prefixed key
-        const workerKey = key.startsWith('worker') ? key : `worker${key.charAt(0).toUpperCase()}${key.slice(1)}`;
-        fixtures[workerKey] = [
-            async ({ workerPage }, use) => {
-                const PageClass = classes[key];
-                const instance = new PageClass(workerPage);
-                await use(instance);
-            },
-            { scope: 'worker' }
-        ];
+        const PageClass = classes[key];
+        const { pageKey, workerKey } = getPageKeyAliases(key);
+        fixtures[pageKey] = createPageFixture(PageClass);
+        fixtures[workerKey] = createWorkerFixture(PageClass);
     }
+    return fixtures;
+}
+function createPageRegistryWithClasses(registry, classes, base) {
+    const fixtures = createRegistryFixtures(registry, classes);
     // Copy worker and non-worker aliases in pages and classes dictionaries
     const extendedClasses = { ...classes };
     for (const key of Object.keys(classes)) {
-        if (key.startsWith('worker')) {
-            const unPrefixed = key.slice(6).charAt(0).toLowerCase() + key.slice(7);
-            if (unPrefixed && !extendedClasses[unPrefixed]) {
-                extendedClasses[unPrefixed] = classes[key];
-            }
+        const { pageKey, workerKey } = getPageKeyAliases(key);
+        if (!extendedClasses[pageKey]) {
+            extendedClasses[pageKey] = classes[key];
         }
-        else {
-            const workerKey = `worker${key.charAt(0).toUpperCase()}${key.slice(1)}`;
-            if (!extendedClasses[workerKey]) {
-                extendedClasses[workerKey] = classes[key];
-            }
+        if (!extendedClasses[workerKey]) {
+            extendedClasses[workerKey] = classes[key];
         }
     }
-    const testRunner = base.extend(fixtures);
-    testRunner.pages = extendedClasses;
-    testRunner.classes = extendedClasses;
-    const originalExtend = testRunner.extend.bind(testRunner);
-    testRunner.extend = (overrides, customBase = test_1.default) => {
+    // Playwright compatibility boundary: extend test runner with fixtures and attach registry dictionaries
+    const rawRunner = base.extend(fixtures);
+    rawRunner.pages = extendedClasses;
+    rawRunner.classes = extendedClasses;
+    const originalExtend = rawRunner.extend.bind(rawRunner);
+    rawRunner.extend = (overrides, customBase = test_1.default) => {
         if (!overrides) {
             return originalExtend();
         }
-        const isPlaywrightFixtures = Object.values(overrides).every((val) => (typeof val === 'function' && !val.toString().startsWith('class')) || Array.isArray(val));
+        const overridesObj = overrides;
+        const isPlaywrightFixtures = Object.values(overridesObj).every((val) => (typeof val === 'function' && !val.toString().startsWith('class')) || Array.isArray(val));
         if (isPlaywrightFixtures) {
             const runner = originalExtend(overrides);
             runner.pages = extendedClasses;
             runner.classes = extendedClasses;
-            runner.extend = testRunner.extend;
+            runner.extend = rawRunner.extend;
             return runner;
         }
         const newClasses = { ...classes };
-        for (const key of Object.keys(overrides)) {
-            if (overrides[key]) {
-                newClasses[key] = overrides[key];
+        for (const key of Object.keys(overridesObj)) {
+            if (overridesObj[key]) {
+                newClasses[key] = overridesObj[key];
             }
         }
-        return createPageRegistryWithClasses(registry, newClasses, customBase);
+        return createPageRegistryWithClasses(registry, newClasses, (customBase ?? test_1.default));
     };
-    return testRunner;
+    return rawRunner;
 }
 /**
  * Creates a page registry that registers page objects as Playwright fixtures,
@@ -108,35 +112,35 @@ function createPageRegistryWithClasses(registry, classes, base) {
  *
  * // returns the extended test runner directly
  * const test = createPageRegistry({
-    codegenPage: {
-      url: '/',
-      selectors: {
-        '{item}': {
-          item: ['why-pw-core', 'why-not-playwright', 'registry', 'typed-page', 'features'],
-          selector: '[data-parent-id="{item}"]'
-        },
-        copyToClipboardBtn: '.page',
-        dynamicLocators: 'text="Dynamic Locators" >> nth=0',
-        rootrailthumbright: '#rootRailThumbRight',
-        'text{item}': {
-          item: ['Auto Steps', 'Capabilities >> nth=0', 'Secret Masking'],
-          selector: 'text="{item}"'
-        },
-        tshirts: '.title-title',
-        tShirts: 'internal:role=link[name="T-Shirts"s]'
-      },
-      testIds: {
-        qaWorkspaceBtn: 'active-workspace-btn',
-        wsOptionApp: 'ws-option-app'
-      }
-    },
-    blankPage: {
-      url: '/',
-      selectors: {
-        element: '[data-pw-cursor="pointer"]'
-      }
-    }
-  });
+     codegenPage: {
+       url: '/',
+       selectors: {
+         '{item}': {
+           item: ['why-pw-core', 'why-not-playwright', 'registry', 'typed-page', 'features'],
+           selector: '[data-parent-id="{item}"]'
+         },
+         copyToClipboardBtn: '.page',
+         dynamicLocators: 'text="Dynamic Locators" >> nth=0',
+         rootrailthumbright: '#rootRailThumbRight',
+         'text{item}': {
+           item: ['Auto Steps', 'Capabilities >> nth=0', 'Secret Masking'],
+           selector: 'text="{item}"'
+         },
+         tshirts: '.title-title',
+         tShirts: 'internal:role=link[name="T-Shirts"s]'
+       },
+       testIds: {
+         qaWorkspaceBtn: 'active-workspace-btn',
+         wsOptionApp: 'ws-option-app'
+       }
+     },
+     blankPage: {
+       url: '/',
+       selectors: {
+         element: '[data-pw-cursor="pointer"]'
+       }
+     }
+   });
  *
  * // returns page classes only when accessing .pages
  * const pages = createPageRegistry({

package/dist/page/typed-page.d.ts

@@ -10,6 +10,7 @@ declare class TypedPageClass<T extends PageConfig> {
     constructor(context: Page | Locator, config: T, options?: {
         timeout?: number;
     });
+    private resolveTarget;
     /** Navigate to the URL from page config. */
     goto(options?: {
         referrer?: string;

package/dist/page/typed-page.js

@@ -17,12 +17,13 @@ class TypedPageClass {
     timeout;
     constructor(context, config, options) {
         this.context = context;
-        this.page = typeof context.page === 'function' ? context.page() : context;
+        const hasPageFn = typeof context.page === 'function';
+        this.page = hasPageFn ? context.page() : context;
         this.config = config;
         this.url = config.url;
         this.timeout = options?.timeout;
         (0, resolver_1.defineLocators)(this, this.context, this.config);
-        (0, locator_actions_1.defineActionMethods)(this, this.resolveLocator.bind(this), this.timeout);
+        (0, locator_actions_1.defineActionMethods)(this, this.resolveTarget.bind(this), this.timeout);
         // Auto-wrap subclass methods with Playwright test.step
         const builtInMethods = new Set([
             'constructor',
@@ -79,6 +80,9 @@ class TypedPageClass {
             proto = Object.getPrototypeOf(proto);
         }
     }
+    resolveTarget(target, options) {
+        return (0, resolver_1.resolveLocator)(this.context, this.config, target, options);
+    }
     /** Navigate to the URL from page config. */
     async goto(options) {
         return (0, page_actions_1.goto)(this.page, this.url, this.constructor.name, options, (0, caller_location_1.getCallerLocation)());
@@ -104,7 +108,7 @@ class TypedPageClass {
         return (0, page_actions_1.waitForURL)(this.page, this.url, this.constructor.name, urlOrOptions, options, (0, caller_location_1.getCallerLocation)());
     }
     resolveLocator(target, options) {
-        return (0, resolver_1.resolveLocator)(this.context, this.config, target, options);
+        return this.resolveTarget(target, options);
     }
     /** Resolve a config key to a proxied Locator with step-wrapped methods. */
     locator(target, options) {
@@ -126,26 +130,32 @@ class TypedPageClass {
                 options = arg;
             }
         }
-        let loc = (0, resolver_1.resolveLocator)(this.context, this.config, keys[0], options);
-        for (let i = 1; i < keys.length; i++) {
-            loc = (0, resolver_1.resolveLocator)(loc, this.config, keys[i], options);
+        const [firstKey, ...remainingKeys] = keys;
+        if (!firstKey) {
+            throw new Error('chain requires at least one locator key.');
+        }
+        let loc = (0, resolver_1.resolveLocator)(this.context, this.config, firstKey, { raw: true });
+        for (let i = 0; i < remainingKeys.length; i++) {
+            const key = remainingKeys[i];
+            const isLast = i === remainingKeys.length - 1;
+            loc = (0, resolver_1.resolveLocator)(loc, this.config, key, isLast ? options : { raw: true });
         }
-        return loc;
+        return remainingKeys.length > 0 ? loc : (0, resolver_1.resolveLocator)(this.context, this.config, firstKey, options);
     }
     /** Chainable assertions on config keys. Supports `.soft` for soft assertions. */
     get verify() {
-        const fn = (target, opts) => (0, verify_chain_1.createVerifyChain)(this.resolveLocator.bind(this), target, opts, false);
-        fn.soft = (target, opts) => (0, verify_chain_1.createVerifyChain)(this.resolveLocator.bind(this), target, opts, true);
+        const fn = ((target, opts) => (0, verify_chain_1.createVerifyChain)(this.resolveTarget.bind(this), target, opts, false));
+        fn.soft = (target, opts) => (0, verify_chain_1.createVerifyChain)(this.resolveTarget.bind(this), target, opts, true);
         return fn;
     }
     async verifyHidden(target, options) {
-        return (0, verify_helpers_1.verifyHidden)(this.resolveLocator.bind(this), target, options, (0, caller_location_1.getCallerLocation)());
+        return (0, verify_helpers_1.verifyHidden)(this.resolveTarget.bind(this), target, options, (0, caller_location_1.getCallerLocation)());
     }
     async verifyEnabled(target, options) {
-        return (0, verify_helpers_1.verifyEnabled)(this.resolveLocator.bind(this), target, options, (0, caller_location_1.getCallerLocation)());
+        return (0, verify_helpers_1.verifyEnabled)(this.resolveTarget.bind(this), target, options, (0, caller_location_1.getCallerLocation)());
     }
     async verifyDisabled(target, options) {
-        return (0, verify_helpers_1.verifyDisabled)(this.resolveLocator.bind(this), target, options, (0, caller_location_1.getCallerLocation)());
+        return (0, verify_helpers_1.verifyDisabled)(this.resolveTarget.bind(this), target, options, (0, caller_location_1.getCallerLocation)());
     }
     expect(target, message) {
         const resolved = typeof target !== 'string' ? target : this.resolveLocator(target);

package/dist/page/types/proxy-methods.d.ts

@@ -1,5 +1,5 @@
-import { Locator } from '@playwright/test';
-import type { PageKeys, CheckableLocatorKeys, CheckboxLocatorKeys, EditableLocatorKeys, SelectableLocatorKeys, ModifyOptionsForTarget } from '../config';
+import type { Locator } from '@playwright/test';
+import type { ModifyOptionsForTarget, PageKeys } from '../config';
 export interface ProxyLocatorMethods<T> {
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-click Locator.click} */
     click<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['click']>[0]>): Promise<void>;
@@ -12,15 +12,15 @@ export interface ProxyLocatorMethods<T> {
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-blur Locator.blur} */
     blur<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['blur']>[0]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-check Locator.check} */
-    check<Target extends CheckableLocatorKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['check']>[0]>): Promise<void>;
+    check<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['check']>[0]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-uncheck Locator.uncheck} */
-    uncheck<Target extends CheckboxLocatorKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['uncheck']>[0]>): Promise<void>;
+    uncheck<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['uncheck']>[0]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-clear Locator.clear} */
-    clear<Target extends EditableLocatorKeys<T> | (string & {}) | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['clear']>[0]>): Promise<void>;
+    clear<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['clear']>[0]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-wait-for Locator.waitFor} */
     waitFor<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['waitFor']>[0]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-is-checked Locator.isChecked} */
-    isChecked<Target extends CheckableLocatorKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['isChecked']>[0]>): Promise<boolean>;
+    isChecked<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['isChecked']>[0]>): Promise<boolean>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-is-disabled Locator.isDisabled} */
     isDisabled<Target extends PageKeys<T> | Locator>(target: Target, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['isDisabled']>[0]>): Promise<boolean>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-is-visible Locator.isVisible} */
@@ -45,29 +45,21 @@ export interface ProxyLocatorMethods<T> {
         height: number;
     } | null>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-press Locator.press} */
-    press<Target extends EditableLocatorKeys<T> | (string & {}) | Locator>(target: Target, key: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['press']>[1]>): Promise<void>;
+    press<Target extends PageKeys<T> | Locator>(target: Target, key: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['press']>[1]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-press-sequentially Locator.pressSequentially} */
-    pressSequentially<Target extends EditableLocatorKeys<T> | (string & {}) | Locator>(target: Target, value: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['pressSequentially']>[1]>): Promise<void>;
+    pressSequentially<Target extends PageKeys<T> | Locator>(target: Target, value: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['pressSequentially']>[1]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-select-option Locator.selectOption} */
-    selectOption<Target extends SelectableLocatorKeys<T> | (string & {}) | Locator>(target: Target, values: string | string[] | {
+    selectOption<Target extends PageKeys<T> | Locator>(target: Target, values: string | string[] | {
         value?: string;
         label?: string;
         index?: number;
     } | null, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['selectOption']>[1]>): Promise<string[]>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-set-input-files Locator.setInputFiles} */
-    setInputFiles<Target extends PageKeys<T> | Locator>(target: Target, files: string | string[] | {
-        name: string;
-        mimeType: string;
-        buffer: Buffer;
-    } | {
-        name: string;
-        mimeType: string;
-        buffer: Buffer;
-    }[], options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['setInputFiles']>[1]>): Promise<void>;
+    setInputFiles<Target extends PageKeys<T> | Locator>(target: Target, files: Parameters<Locator['setInputFiles']>[0], options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['setInputFiles']>[1]>): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-get-attribute Locator.getAttribute} */
     getAttribute<Target extends PageKeys<T> | Locator>(target: Target, name: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['getAttribute']>[1]>): Promise<string | null>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-fill Locator.fill} */
-    fill<Target extends EditableLocatorKeys<T> | (string & {}) | Locator>(target: Target, value: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['fill']>[1]> & {
+    fill<Target extends PageKeys<T> | Locator>(target: Target, value: string, options?: ModifyOptionsForTarget<T, Target, Parameters<Locator['fill']>[1]> & {
         mask?: boolean;
     }): Promise<void>;
     /** @see {@link https://playwright.dev/docs/api/class-locator#locator-drag-to Locator.dragTo} */

package/dist/page/types/validation.d.ts

@@ -10,7 +10,7 @@ export type HasDuplicatePlaceholders<S extends string, Seen extends string = nev
  * Returns the subset of `Placeholders` whose names are NOT found as
  * substrings of `TestId`. Evaluates to `never` when all are present.
  */
-export type MissingInTestId<TestId extends string, Placeholders extends string> = Placeholders extends any ? TestId extends `${string}${Placeholders}${string}` ? never : Placeholders : never;
+export type MissingInTestId<TestId extends string, Placeholders extends string> = Placeholders extends unknown ? TestId extends `${string}${Placeholders}${string}` ? never : Placeholders : never;
 /**
  * Validates a dynamic entry by mapping each of its properties to their expected types.
  *

package/dist/page/utils/formatter.d.ts

@@ -1,3 +1,3 @@
-export declare function formatTarget(target: any): string;
-export declare function formatStepDescription(methodName: string, target: any, args: any[]): string;
-export declare function formatAssertionDescription(target: any, matcherName: string, isNegated: boolean, args: any[]): string;
+export declare function formatTarget(target: unknown): string;
+export declare function formatStepDescription(methodName: string, target: unknown, args: readonly unknown[]): string;
+export declare function formatAssertionDescription(target: unknown, matcherName: string, isNegated: boolean, args: readonly unknown[]): string;

package/dist/page/utils/formatter.js

@@ -3,10 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatTarget = formatTarget;
 exports.formatStepDescription = formatStepDescription;
 exports.formatAssertionDescription = formatAssertionDescription;
+function isStringifiable(value) {
+    return typeof value === 'object' && value !== null && typeof value.toString === 'function';
+}
 function formatTarget(target) {
     if (typeof target === 'string')
         return target;
-    if (target && typeof target.toString === 'function') {
+    if (isStringifiable(target)) {
         return target.toString().replace(/^Locator@/, '');
     }
     return 'locator';
@@ -16,7 +19,7 @@ function formatStepDescription(methodName, target, args) {
     if (methodName === 'fill' && args[0] !== undefined) {
         const options = args[1];
         let shouldMask = false;
-        if (options && typeof options === 'object' && options.mask !== undefined) {
+        if (options && typeof options === 'object' && 'mask' in options && options.mask !== undefined) {
             shouldMask = options.mask === true;
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pw-core",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "workspaces": [
     "examples",
     "create-pw-core"
@@ -53,14 +53,17 @@
   "scripts": {
     "build": "node -e \"const fs = require('fs'); fs.rmSync('dist', {recursive:true,force:true})\" && tsc && npm run build --prefix create-pw-core",
     "prepare": "npm run build",
-    "test": "npm run test --workspace=pw-core-demo"
+    "test": "npm run test --workspace=pw-core-demo",
+    "test:unit": "npm run build && node --test tests/unit/*.test.js",
+    "test:types": "tsc --noEmit -p tests/types/tsconfig.json",
+    "test:codegen": "npm run build && node scripts/verify-codegen.js"
   },
   "peerDependencies": {
     "@playwright/test": "^1.40.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.61.0",
-    "@types/node": "^20.11.0",
+    "@types/node": "^20.19.43",
     "prettier": "^3.9.4",
     "rimraf": "^6.0.1",
     "typescript": "^5.3.3"