@serenity-js/playwright-test 3.10.2 → 3.10.3

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.10.3](https://github.com/serenity-js/serenity-js/compare/v3.10.2...v3.10.3) (2023-09-15)
+
+
+### Bug Fixes
+
+* **deps:** update playwright dependencies to ^1.38.0 ([0b8074b](https://github.com/serenity-js/serenity-js/commit/0b8074b19155a38aa2009049d9a395b7026d12b3))
+* **playwright-test:** simplified and documented implementing custom Playwright Test fixtures ([61fc2bc](https://github.com/serenity-js/serenity-js/commit/61fc2bce72c9758658851949afac84d573698677)), closes [microsoft/playwright#24146](https://github.com/microsoft/playwright/issues/24146)
+
+
+
+
+
 ## [3.10.2](https://github.com/serenity-js/serenity-js/compare/v3.10.1...v3.10.2) (2023-09-10)
 
 

package/README.md

@@ -228,6 +228,60 @@ test.use({
 })
 ```
 
+#### Customising test fixtures
+
+[`useFixtures`](https://serenity-js.org/api/playwright-test/function/useFixtures/) lets you configure
+Serenity/JS Screenplay Pattern actors in a single place,
+and define custom [test fixtures](https://playwright.dev/docs/test-fixtures) if needed.   
+
+```typescript
+// my-custom-api.ts
+export const { 
+    describe, it, test, beforeAll, beforeEach, afterEach, afterAll, expect
+} = useFixtures<{ email: string }>({
+    
+    // Override Serenity/JS fixtures:
+    actors: async ({ browser, baseURL }, use) => {
+        await use(
+            Cast.where(actor => actor.whoCan(
+                BrowseTheWebWithPlaywright.using(browser),
+                TakeNotes.usingAnEmptyNotepad(),
+                CallAnApi.at(baseURL),
+            ))
+        )
+    },
+    
+    // Add your own fixtures:
+    email: async ({ actor }, use) => {
+        await use(`${ actor.name }@example.org`);
+    },    
+})
+```
+
+With the custom test API definition in place, use it in your test files instead of the default one:
+
+```typescript
+// example.spec.ts
+import { Log } from '@serenity-js/core'
+
+import { describe, it, test } from './my-custom-api'    // Note the custom test API
+
+describe('Serenity Screenplay with Playwright', () => {
+
+    describe('New Todo', () => {
+
+        // inject default actor:
+        it('should allow me to add todo items', async ({ actor, email }) => {
+
+            // define test workflow
+            await actor.attemptsTo(
+                Log.the(email),
+            )
+        })
+    })
+})
+```
+
 ### UI Component Testing
 
 You can use Serenity/JS and Playwright Test to write UI component tests and **reuse your test code** between component and end-to-end test suites.

package/lib/api/DescribeFunction.d.ts

@@ -0,0 +1,235 @@
+import type { SuiteFunction } from './SuiteFunction';
+export type DescribeFunction = SuiteFunction & {
+    /**
+     * Declares a focused group of tests. If there are some focused tests or suites, all of them will be run but nothing
+     * else.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.only('focused group', () => {
+     *   test('in the focused group', async ({ page }) => {
+     *     // This test will run
+     *   });
+     * });
+     * test('not in the focused group', async ({ page }) => {
+     *   // This test will not run
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.only(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-only). Any tests
+     * added in this callback will belong to the group.
+     */
+    only: SuiteFunction;
+    /**
+     * Declares a skipped test group, similarly to
+     * [test.describe(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-1). Tests in the skipped
+     * group are never run.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.skip('skipped group', () => {
+     *   test('example', async ({ page }) => {
+     *     // This test will not run
+     *   });
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.skip(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-skip). Any tests
+     * added in this callback will belong to the group, and will not be run.
+     */
+    skip: SuiteFunction;
+    /**
+     * Declares a test group similarly to
+     * [test.describe(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-1). Tests in this group
+     * are marked as "fixme" and will not be executed.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.fixme('broken tests', () => {
+     *   test('example', async ({ page }) => {
+     *     // This test will not run
+     *   });
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.fixme(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-fixme). Any tests
+     * added in this callback will belong to the group, and will not be run.
+     */
+    fixme: SuiteFunction;
+    /**
+     * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+     * the preferred way of configuring the execution mode.
+     *
+     * Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are
+     * skipped. All tests in a group are retried together.
+     *
+     * **NOTE** Using serial is not recommended. It is usually better to make your tests isolated, so they can be run
+     * independently.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.serial('group', () => {
+     *   test('runs first', async ({ page }) => {});
+     *   test('runs second', async ({ page }) => {});
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.serial(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-serial). Any tests
+     * added in this callback will belong to the group.
+     */
+    serial: SuiteFunction & {
+        /**
+         * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+         * the preferred way of configuring the execution mode.
+         *
+         * Declares a focused group of tests that should always be run serially. If one of the tests fails, all subsequent
+         * tests are skipped. All tests in a group are retried together. If there are some focused tests or suites, all of
+         * them will be run but nothing else.
+         *
+         * **NOTE** Using serial is not recommended. It is usually better to make your tests isolated, so they can be run
+         * independently.
+         *
+         * **Usage**
+         *
+         * ```js
+         * test.describe.serial.only('group', () => {
+         *   test('runs first', async ({ page }) => {
+         *   });
+         *   test('runs second', async ({ page }) => {
+         *   });
+         * });
+         * ```
+         *
+         * @param title Group title.
+         * @param callback A callback that is run immediately when calling
+         * [test.describe.serial.only(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-serial-only).
+         * Any tests added in this callback will belong to the group.
+         */
+        only: SuiteFunction;
+    };
+    /**
+     * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+     * the preferred way of configuring the execution mode.
+     *
+     * Declares a group of tests that could be run in parallel. By default, tests in a single test file run one after
+     * another, but using
+     * [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel) allows
+     * them to run in parallel.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.parallel('group', () => {
+     *   test('runs in parallel 1', async ({ page }) => {});
+     *   test('runs in parallel 2', async ({ page }) => {});
+     * });
+     * ```
+     *
+     * Note that parallel tests are executed in separate processes and cannot share any state or global variables. Each of
+     * the parallel tests executes all relevant hooks.
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel). Any
+     * tests added in this callback will belong to the group.
+     */
+    parallel: SuiteFunction & {
+        /**
+         * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+         * the preferred way of configuring the execution mode.
+         *
+         * Declares a focused group of tests that could be run in parallel. This is similar to
+         * [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel), but
+         * focuses the group. If there are some focused tests or suites, all of them will be run but nothing else.
+         *
+         * **Usage**
+         *
+         * ```js
+         * test.describe.parallel.only('group', () => {
+         *   test('runs in parallel 1', async ({ page }) => {});
+         *   test('runs in parallel 2', async ({ page }) => {});
+         * });
+         * ```
+         *
+         * @param title Group title.
+         * @param callback A callback that is run immediately when calling
+         * [test.describe.parallel.only(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel-only).
+         * Any tests added in this callback will belong to the group.
+         */
+        only: SuiteFunction;
+    };
+    /**
+     * Configures the enclosing scope. Can be executed either on the top level or inside a describe. Configuration applies
+     * to the entire scope, regardless of whether it run before or after the test declaration.
+     *
+     * Learn more about the execution modes [here](https://playwright.dev/docs/test-parallel).
+     *
+     * **Usage**
+     * - Running tests in parallel.
+     *
+     *   ```js
+     *   // Run all the tests in the file concurrently using parallel workers.
+     *   test.describe.configure({ mode: 'parallel' });
+     *   test('runs in parallel 1', async ({ page }) => {});
+     *   test('runs in parallel 2', async ({ page }) => {});
+     *   ```
+     *
+     * - Running tests serially, retrying from the start.
+     *
+     *   **NOTE** Running serially is not recommended. It is usually better to make your tests isolated, so they can be
+     *   run independently.
+     *
+     *   ```js
+     *   // Annotate tests as inter-dependent.
+     *   test.describe.configure({ mode: 'serial' });
+     *   test('runs first', async ({ page }) => {});
+     *   test('runs second', async ({ page }) => {});
+     *   ```
+     *
+     * - Configuring retries and timeout for each test.
+     *
+     *   ```js
+     *   // Each test in the file will be retried twice and have a timeout of 20 seconds.
+     *   test.describe.configure({ retries: 2, timeout: 20_000 });
+     *   test('runs first', async ({ page }) => {});
+     *   test('runs second', async ({ page }) => {});
+     *   ```
+     *
+     * - Run multiple describes in parallel, but tests inside each describe in order.
+     *
+     *   ```js
+     *   test.describe.configure({ mode: 'parallel' });
+     *
+     *   test.describe('A, runs in parallel with B', () => {
+     *     test.describe.configure({ mode: 'default' });
+     *     test('in order A1', async ({ page }) => {});
+     *     test('in order A2', async ({ page }) => {});
+     *   });
+     *
+     *   test.describe('B, runs in parallel with A', () => {
+     *     test.describe.configure({ mode: 'default' });
+     *     test('in order B1', async ({ page }) => {});
+     *     test('in order B2', async ({ page }) => {});
+     *   });
+     *   ```
+     *
+     * @param options
+     */
+    configure: (options: {
+        mode?: 'default' | 'parallel' | 'serial';
+        retries?: number;
+        timeout?: number;
+    }) => void;
+};
+//# sourceMappingURL=DescribeFunction.d.ts.map

package/lib/api/DescribeFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DescribeFunction.d.ts","sourceRoot":"","sources":["../../src/api/DescribeFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIrD,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,EAAE,aAAa,CAAC;IACrB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,EAAE,aAAa,GAAG;QACpB;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,IAAI,EAAE,aAAa,CAAC;KACvB,CAAC;IACF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,EAAE,aAAa,GAAG;QACtB;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,IAAI,EAAE,aAAa,CAAC;KACvB,CAAC;IACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAClH,CAAA"}

package/lib/api/DescribeFunction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DescribeFunction.js.map

package/lib/api/DescribeFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DescribeFunction.js","sourceRoot":"","sources":["../../src/api/DescribeFunction.ts"],"names":[],"mappings":""}

package/lib/api/SuiteFunction.d.ts

@@ -0,0 +1,51 @@
+export interface SuiteFunction {
+    /**
+     * Declares a group of tests.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe('two tests', () => {
+     *   test('one', async ({ page }) => {
+     *     // ...
+     *   });
+     *
+     *   test('two', async ({ page }) => {
+     *     // ...
+     *   });
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-1). Any tests added in
+     * this callback will belong to the group.
+     */
+    (title: string, callback: () => void): void;
+    /**
+     * Declares an anonymous group of tests. This is convenient to give a group of tests a common option with
+     * [test.use(options)](https://playwright.dev/docs/api/class-test#test-use).
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe(() => {
+     *   test.use({ colorScheme: 'dark' });
+     *
+     *   test('one', async ({ page }) => {
+     *     // ...
+     *   });
+     *
+     *   test('two', async ({ page }) => {
+     *     // ...
+     *   });
+     * });
+     * ```
+     *
+     * @param callback A callback that is run immediately when calling
+     * [test.describe(callback)](https://playwright.dev/docs/api/class-test#test-describe-2). Any tests added in this
+     * callback will belong to the group.
+     */
+    (callback: () => void): void;
+}
+//# sourceMappingURL=SuiteFunction.d.ts.map

package/lib/api/SuiteFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SuiteFunction.d.ts","sourceRoot":"","sources":["../../src/api/SuiteFunction.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,aAAa;IAC1B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC5C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAChC"}

package/lib/api/SuiteFunction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SuiteFunction.js.map

package/lib/api/SuiteFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SuiteFunction.js","sourceRoot":"","sources":["../../src/api/SuiteFunction.ts"],"names":[],"mappings":""}

package/lib/api/index.d.ts

@@ -1,5 +1,7 @@
+export * from './DescribeFunction';
 export * from './PlaywrightTestConfig';
 export * from './SerenityFixtures';
 export * from './SerenityOptions';
+export * from './SuiteFunction';
 export * from './test-api';
 //# sourceMappingURL=index.d.ts.map

package/lib/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC"}

package/lib/api/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./DescribeFunction"), exports);
 __exportStar(require("./PlaywrightTestConfig"), exports);
 __exportStar(require("./SerenityFixtures"), exports);
 __exportStar(require("./SerenityOptions"), exports);
+__exportStar(require("./SuiteFunction"), exports);
 __exportStar(require("./test-api"), exports);
 //# sourceMappingURL=index.js.map

package/lib/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,qDAAmC;AACnC,oDAAkC;AAClC,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,yDAAuC;AACvC,qDAAmC;AACnC,oDAAkC;AAClC,kDAAgC;AAChC,6CAA2B"}

package/lib/api/test-api.d.ts

@@ -1,5 +1,5 @@
 import type { Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestInfo, TestType } from '@playwright/test';
-import { test as playwrightBaseTest } from '@playwright/test';
+import type { DescribeFunction } from './DescribeFunction';
 import type { SerenityFixtures } from './SerenityFixtures';
 import type { SerenityOptions } from './SerenityOptions';
 export declare const fixtures: Fixtures<Omit<SerenityOptions, 'actors'> & SerenityFixtures, object, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
@@ -34,7 +34,7 @@ export type TestApi<TestArgs extends Record<string, any>, WorkerArgs extends Rec
     useFixtures: <T extends Record<string, any>, W extends Record<string, any> = object>(customFixtures: Fixtures<T, W, TestArgs, WorkerArgs>) => TestApi<TestArgs & T, WorkerArgs & W>;
     it: TestType<TestArgs, WorkerArgs>;
     test: TestType<TestArgs, WorkerArgs>;
-    describe: typeof playwrightBaseTest.describe;
+    describe: DescribeFunction;
 };
 /**
  * Declares a single test scenario.
@@ -146,11 +146,23 @@ export declare const test: TestType<PlaywrightTestArgs & PlaywrightTestOptions &
  * - [Playwright Test `describe` function](https://playwright.dev/docs/api/class-test#test-describe-1)
  * - [Serenity/JS + Playwright Test project template](https://github.com/serenity-js/serenity-js-playwright-test-template/)
  */
-export declare const describe: typeof playwrightBaseTest.describe;
-export declare const beforeAll: (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any) => void;
-export declare const beforeEach: (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any) => void;
-export declare const afterEach: (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any) => void;
-export declare const afterAll: (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any) => void;
+export declare const describe: DescribeFunction;
+export declare const beforeAll: {
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+};
+export declare const beforeEach: {
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+};
+export declare const afterEach: {
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+};
+export declare const afterAll: {
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => any): void;
+};
 export declare const expect: import("@playwright/test").Expect;
 export declare const useFixtures: <T extends Record<string, any>, W extends Record<string, any> = object>(customFixtures: Fixtures<T, W, PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions & object>) => TestApi<PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & T, PlaywrightWorkerArgs & PlaywrightWorkerOptions & object & W>;
 /**

package/lib/api/test-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-api.d.ts","sourceRoot":"","sources":["../../src/api/test-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACR,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,IAAI,IAAI,kBAAkB,EAAG,MAAM,kBAAkB,CAAC;AAgB/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzD,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,gBAAgB,EAAE,MAAM,EAAE,kBAAkB,GAAG,qBAAqB,EAAE,oBAAoB,GAAG,uBAAuB,CA0HrL,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC5F,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC,GACtG;IACI;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC;IACpL,EAAE,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACnC,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACrC,QAAQ,EAAE,OAAO,kBAAkB,CAAC,QAAQ,CAAC;CAChD,CAAA;AAoBL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,EAAE,oKAAS,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,IAAI,oKAAW,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,kBAAkB,CAAC,QAAuB,CAAC;AAEzE,eAAO,MAAM,SAAS,+MAAgB,CAAC;AAEvC,eAAO,MAAM,UAAU,+MAAiB,CAAC;AAEzC,eAAO,MAAM,SAAS,+MAAgB,CAAC;AAEvC,eAAO,MAAM,QAAQ,+MAAe,CAAC;AAErC,eAAO,MAAM,MAAM,mCAAa,CAAC;AAEjC,eAAO,MAAM,WAAW,gbAAkB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACzG,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,GACzC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,gBAAgB,GAAG,QAAQ,EAAE,UAAU,CAAC,CAGpF"}
+{"version":3,"file":"test-api.d.ts","sourceRoot":"","sources":["../../src/api/test-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACR,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAgB1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzD,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,gBAAgB,EAAE,MAAM,EAAE,kBAAkB,GAAG,qBAAqB,EAAE,oBAAoB,GAAG,uBAAuB,CA0HrL,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC5F,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC,GACtG;IACI;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC;IACpL,EAAE,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACnC,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACrC,QAAQ,EAAE,gBAAgB,CAAC;CAC9B,CAAA;AAoBL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,EAAE,oKAAS,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,IAAI,oKAAW,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,QAAQ,kBAAe,CAAC;AAErC,eAAO,MAAM,SAAS;;;CAAgB,CAAC;AAEvC,eAAO,MAAM,UAAU;;;CAAiB,CAAC;AAEzC,eAAO,MAAM,SAAS;;;CAAgB,CAAC;AAEvC,eAAO,MAAM,QAAQ;;;CAAe,CAAC;AAErC,eAAO,MAAM,MAAM,mCAAa,CAAC;AAEjC,eAAO,MAAM,WAAW,gbAAkB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACzG,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,GACzC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,gBAAgB,GAAG,QAAQ,EAAE,UAAU,CAAC,CAGpF"}

package/lib/api/test-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-api.js","sourceRoot":"","sources":["../../src/api/test-api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AASA,2CAA+D;AAC/D,4CAA+G;AAC/G,yDAA0E;AAC1E,uDAAsE;AACtE,wDAA8F;AAC9F,0CAAsE;AACtE,uCAAyB;AAEzB,2CAA0D;AAE1D,0CAIqB;AACrB,6FAA0F;AAI1F,MAAM,uBAAuB,GAAG,IAAI,oCAAuB,EAAE,CAAC;AAEjD,QAAA,QAAQ,GAAqK;IACtL,MAAM,EAAE;QACJ,6EAA6E;QAC7E,KAAK,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAiB,EAAE;YAC7D,MAAM,GAAG,CAAC,WAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CACtC,uCAA0B,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,CAAC,EAC1D,gBAAS,CAAC,mBAAmB,EAAE,CAClC,CAAC,CAAC,CAAA;QACP,CAAC;QACD,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,UAAU,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE;QACtC,MAAM,uBAAuB,CAAC,oBAAoB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACzE,MAAM,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1B,CAAC;IAED,gBAAgB,EAAE;QACd,QAAQ;QACR,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,UAAU,EAAE;QACR,eAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACrB,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,kBAAkB,EAAE;QAChB,eAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACrB,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,IAAI,EAAE;QACF;YACI,kBAAY,CAAC,OAAO,CAAC,0BAAoB,CAAC;SAC7C;QACD,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,4CAA4C;IAC5C,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACxB,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QAE/B,+DAA+D;QAC/D,MAAM,IAAI,GAAG,QAAQ,KAAK,OAAO;YAC7B,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAc,EAAE,EAAE;QAExF,MAAM,iBAAiB,GAAG,IAAI,4BAAiB,EAAE,CAAC;QAElD,eAAgB,CAAC,SAAS,CAAC;YACvB,aAAa,EAAE,IAAI,wBAAiB,EAAE;YACtC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;YAClC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;YAClD,IAAI,EAAE;gBACF,GAAG,IAAI;gBACP,iBAAiB;gBACjB,IAAI,iCAAsB,CAAC,IAAI,CAAC;aACnC;SACJ,CAAC,CAAC;QAEH,eAAgB,CAAC,QAAQ,CAAC,IAAI,oBAAW,CACrC,eAAgB,CAAC,cAAc,EAAE,EACjC,IAAI,mBAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,EAChD,eAAgB,CAAC,WAAW,EAAE,CACjC,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,eAAgB,CAAC,CAAC;QAE5B,MAAM,gBAAgB,GAA8C,EAAE,CAAC;QAEvE,KAAK,MAAM,KAAK,IAAI,iBAAiB,CAAC,KAAK,EAAE,EAAE;YAC3C,gBAAgB,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI;gBAC5B,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;aACxB,CAAC,CAAC;YAEH,IAAI,KAAK,YAAY,oBAAW,EAAE;gBAC9B,YAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;aACvF;SACJ;QAED,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;YACnC,WAAW,EAAE,4DAAiD;YAC9D,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC9D,CAAC,CAAC;IACP,CAAC;IAED,WAAW,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE;QAEnF,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,EAAE,CAAC;QAE1C,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAEhC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE;YACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC5C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,uEAAkC,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAE,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC;QAEF,QAAQ,CAAC,QAAQ,CAAC,IAAI,oBAAW,CAC7B,OAAO,EACP,IAAI,kBAAU,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,EAC9C,QAAQ,CAAC,WAAW,EAAE,CACzB,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,WAAW,CAAC,CAAC;QAEvB,QAAQ,CAAC,QAAQ,CACb,IAAI,sBAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CACrD,CAAC;QAEF,MAAM,eAAgB,CAAC,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED,KAAK,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,EAAE,GAAG,EAAE,EAAE;QACpD,MAAM,GAAG,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7C,CAAC;CACJ,CAAC;AAsCF,SAAS,aAAa,CAAwF,QAAwC;IAClJ,OAAO;QACH,WAAW,CAAwE,cAAoD;YACnI,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,SAAS,EAAG,QAAQ,CAAC,SAAS;QAC9B,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,SAAS,EAAG,QAAQ,CAAC,SAAS;QAC9B,QAAQ,EAAI,QAAQ,CAAC,QAAQ;QAC7B,QAAQ,EAAI,QAAQ,CAAC,QAAQ;QAC7B,MAAM,EAAM,QAAQ,CAAC,MAAM;QAC3B,EAAE,EAAM,QAAQ;QAChB,IAAI,EAAI,QAAQ;KACnB,CAAC;AACN,CAAC;AAED,MAAM,GAAG,GAAG,aAAa,CAAC,WAAkB,CAAC,CAAC,WAAW,CAAC,gBAAQ,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACU,QAAA,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;AAEzB;;GAEG;AACU,QAAA,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACU,QAAA,QAAQ,GAAuC,GAAG,CAAC,QAAQ,CAAC;AAE5D,QAAA,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;AAE1B,QAAA,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;AAE5B,QAAA,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;AAE1B,QAAA,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;AAExB,QAAA,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;AAEpB,QAAA,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyIG;AACH,SAAgB,OAAO,CACnB,QAAwC;IAExC,OAAO,aAAa,CAAC,QAAQ,CAAC;SACzB,WAAW,CAA4E,gBAAQ,CAAC,CAAC;AAC1G,CAAC;AALD,0BAKC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,aAAgC;IAChD,OAAO,aAAa,YAAY,eAAQ;QACpC,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,eAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,SAAS,MAAM,CAAC,SAAkB;IAC9B,OAAO,IAAA,mBAAM,EAAC,QAAQ,EAAE,SAAiB,EAAE,IAAA,qBAAQ,EAAC,SAAS,EAAE,IAAA,uBAAU,GAAE,CAAC,CAAC,CAAC;AAClF,CAAC"}
+{"version":3,"file":"test-api.js","sourceRoot":"","sources":["../../src/api/test-api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AASA,2CAA8D;AAC9D,4CAA+G;AAC/G,yDAA0E;AAC1E,uDAAsE;AACtE,wDAA8F;AAC9F,0CAAsE;AACtE,uCAAyB;AAEzB,2CAA0D;AAE1D,0CAIqB;AAErB,6FAA0F;AAI1F,MAAM,uBAAuB,GAAG,IAAI,oCAAuB,EAAE,CAAC;AAEjD,QAAA,QAAQ,GAAqK;IACtL,MAAM,EAAE;QACJ,6EAA6E;QAC7E,KAAK,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAiB,EAAE;YAC7D,MAAM,GAAG,CAAC,WAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CACtC,uCAA0B,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,CAAC,EAC1D,gBAAS,CAAC,mBAAmB,EAAE,CAClC,CAAC,CAAC,CAAA;QACP,CAAC;QACD,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,UAAU,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE;QACtC,MAAM,uBAAuB,CAAC,oBAAoB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACzE,MAAM,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1B,CAAC;IAED,gBAAgB,EAAE;QACd,QAAQ;QACR,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,UAAU,EAAE;QACR,eAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACrB,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,kBAAkB,EAAE;QAChB,eAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACrB,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,IAAI,EAAE;QACF;YACI,kBAAY,CAAC,OAAO,CAAC,0BAAoB,CAAC;SAC7C;QACD,EAAE,MAAM,EAAE,IAAI,EAAE;KACnB;IAED,4CAA4C;IAC5C,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACxB,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QAE/B,+DAA+D;QAC/D,MAAM,IAAI,GAAG,QAAQ,KAAK,OAAO;YAC7B,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAc,EAAE,EAAE;QAExF,MAAM,iBAAiB,GAAG,IAAI,4BAAiB,EAAE,CAAC;QAElD,eAAgB,CAAC,SAAS,CAAC;YACvB,aAAa,EAAE,IAAI,wBAAiB,EAAE;YACtC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;YAClC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;YAClD,IAAI,EAAE;gBACF,GAAG,IAAI;gBACP,iBAAiB;gBACjB,IAAI,iCAAsB,CAAC,IAAI,CAAC;aACnC;SACJ,CAAC,CAAC;QAEH,eAAgB,CAAC,QAAQ,CAAC,IAAI,oBAAW,CACrC,eAAgB,CAAC,cAAc,EAAE,EACjC,IAAI,mBAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,EAChD,eAAgB,CAAC,WAAW,EAAE,CACjC,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,eAAgB,CAAC,CAAC;QAE5B,MAAM,gBAAgB,GAA8C,EAAE,CAAC;QAEvE,KAAK,MAAM,KAAK,IAAI,iBAAiB,CAAC,KAAK,EAAE,EAAE;YAC3C,gBAAgB,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI;gBAC5B,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;aACxB,CAAC,CAAC;YAEH,IAAI,KAAK,YAAY,oBAAW,EAAE;gBAC9B,YAAI,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;aACvF;SACJ;QAED,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;YACnC,WAAW,EAAE,4DAAiD;YAC9D,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC9D,CAAC,CAAC;IACP,CAAC;IAED,WAAW,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE;QAEnF,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,EAAE,CAAC;QAE1C,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAEhC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE;YACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC5C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,uEAAkC,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAE,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC;QAEF,QAAQ,CAAC,QAAQ,CAAC,IAAI,oBAAW,CAC7B,OAAO,EACP,IAAI,kBAAU,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,EAC9C,QAAQ,CAAC,WAAW,EAAE,CACzB,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,WAAW,CAAC,CAAC;QAEvB,QAAQ,CAAC,QAAQ,CACb,IAAI,sBAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CACrD,CAAC;QAEF,MAAM,eAAgB,CAAC,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED,KAAK,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,EAAE,GAAG,EAAE,EAAE;QACpD,MAAM,GAAG,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7C,CAAC;CACJ,CAAC;AAsCF,SAAS,aAAa,CAAwF,QAAwC;IAClJ,OAAO;QACH,WAAW,CAAwE,cAAoD;YACnI,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,SAAS,EAAG,QAAQ,CAAC,SAAS;QAC9B,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,SAAS,EAAG,QAAQ,CAAC,SAAS;QAC9B,QAAQ,EAAI,QAAQ,CAAC,QAAQ;QAC7B,QAAQ,EAAI,QAAQ,CAAC,QAAQ;QAC7B,MAAM,EAAM,QAAQ,CAAC,MAAM;QAC3B,EAAE,EAAM,QAAQ;QAChB,IAAI,EAAI,QAAQ;KACnB,CAAC;AACN,CAAC;AAED,MAAM,GAAG,GAAG,aAAa,CAAC,WAAkB,CAAC,CAAC,WAAW,CAAC,gBAAQ,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACU,QAAA,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;AAEzB;;GAEG;AACU,QAAA,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACU,QAAA,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;AAExB,QAAA,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;AAE1B,QAAA,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;AAE5B,QAAA,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;AAE1B,QAAA,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;AAExB,QAAA,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;AAEpB,QAAA,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyIG;AACH,SAAgB,OAAO,CACnB,QAAwC;IAExC,OAAO,aAAa,CAAC,QAAQ,CAAC;SACzB,WAAW,CAA4E,gBAAQ,CAAC,CAAC;AAC1G,CAAC;AALD,0BAKC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,aAAgC;IAChD,OAAO,aAAa,YAAY,eAAQ;QACpC,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,eAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,SAAS,MAAM,CAAC,SAAkB;IAC9B,OAAO,IAAA,mBAAM,EAAC,QAAQ,EAAE,SAAiB,EAAE,IAAA,qBAAQ,EAAC,SAAS,EAAE,IAAA,uBAAU,GAAE,CAAC,CAAC,CAAC;AAClF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/playwright-test",
-  "version": "3.10.2",
+  "version": "3.10.3",
   "description": "Serenity/JS reporter and test APIs for Playwright Test",
   "author": {
     "name": "Jan Molak",
@@ -44,10 +44,10 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@playwright/test": "^1.37.1",
-    "@serenity-js/core": "3.10.2",
-    "@serenity-js/playwright": "3.10.2",
-    "@serenity-js/web": "3.10.2",
+    "@playwright/test": "^1.38.0",
+    "@serenity-js/core": "3.10.3",
+    "@serenity-js/playwright": "3.10.3",
+    "@serenity-js/web": "3.10.3",
     "deepmerge": "^4.3.1",
     "tiny-types": "^1.20.0"
   },
@@ -61,5 +61,5 @@
     "ts-node": "^10.9.1",
     "typescript": "5.1.6"
   },
-  "gitHead": "6834827fffe5dd8dd3d2f39d2fea2c4039ab1d3d"
+  "gitHead": "064edb63e8d4dee447feaab63cf61cbcf6414fdf"
 }

package/src/api/DescribeFunction.ts

@@ -0,0 +1,233 @@
+import type { SuiteFunction } from './SuiteFunction';
+
+// Playwright Test doesn't export all its public APIs, hence the need for this workaround
+// See https://github.com/microsoft/playwright/pull/24146
+export type DescribeFunction = SuiteFunction & {
+    /**
+     * Declares a focused group of tests. If there are some focused tests or suites, all of them will be run but nothing
+     * else.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.only('focused group', () => {
+     *   test('in the focused group', async ({ page }) => {
+     *     // This test will run
+     *   });
+     * });
+     * test('not in the focused group', async ({ page }) => {
+     *   // This test will not run
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.only(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-only). Any tests
+     * added in this callback will belong to the group.
+     */
+    only: SuiteFunction;
+    /**
+     * Declares a skipped test group, similarly to
+     * [test.describe(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-1). Tests in the skipped
+     * group are never run.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.skip('skipped group', () => {
+     *   test('example', async ({ page }) => {
+     *     // This test will not run
+     *   });
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.skip(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-skip). Any tests
+     * added in this callback will belong to the group, and will not be run.
+     */
+    skip: SuiteFunction;
+    /**
+     * Declares a test group similarly to
+     * [test.describe(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-1). Tests in this group
+     * are marked as "fixme" and will not be executed.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.fixme('broken tests', () => {
+     *   test('example', async ({ page }) => {
+     *     // This test will not run
+     *   });
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.fixme(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-fixme). Any tests
+     * added in this callback will belong to the group, and will not be run.
+     */
+    fixme: SuiteFunction;
+    /**
+     * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+     * the preferred way of configuring the execution mode.
+     *
+     * Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are
+     * skipped. All tests in a group are retried together.
+     *
+     * **NOTE** Using serial is not recommended. It is usually better to make your tests isolated, so they can be run
+     * independently.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.serial('group', () => {
+     *   test('runs first', async ({ page }) => {});
+     *   test('runs second', async ({ page }) => {});
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.serial(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-serial). Any tests
+     * added in this callback will belong to the group.
+     */
+    serial: SuiteFunction & {
+        /**
+         * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+         * the preferred way of configuring the execution mode.
+         *
+         * Declares a focused group of tests that should always be run serially. If one of the tests fails, all subsequent
+         * tests are skipped. All tests in a group are retried together. If there are some focused tests or suites, all of
+         * them will be run but nothing else.
+         *
+         * **NOTE** Using serial is not recommended. It is usually better to make your tests isolated, so they can be run
+         * independently.
+         *
+         * **Usage**
+         *
+         * ```js
+         * test.describe.serial.only('group', () => {
+         *   test('runs first', async ({ page }) => {
+         *   });
+         *   test('runs second', async ({ page }) => {
+         *   });
+         * });
+         * ```
+         *
+         * @param title Group title.
+         * @param callback A callback that is run immediately when calling
+         * [test.describe.serial.only(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-serial-only).
+         * Any tests added in this callback will belong to the group.
+         */
+        only: SuiteFunction;
+    };
+    /**
+     * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+     * the preferred way of configuring the execution mode.
+     *
+     * Declares a group of tests that could be run in parallel. By default, tests in a single test file run one after
+     * another, but using
+     * [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel) allows
+     * them to run in parallel.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe.parallel('group', () => {
+     *   test('runs in parallel 1', async ({ page }) => {});
+     *   test('runs in parallel 2', async ({ page }) => {});
+     * });
+     * ```
+     *
+     * Note that parallel tests are executed in separate processes and cannot share any state or global variables. Each of
+     * the parallel tests executes all relevant hooks.
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel). Any
+     * tests added in this callback will belong to the group.
+     */
+    parallel: SuiteFunction & {
+        /**
+         * **NOTE** See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
+         * the preferred way of configuring the execution mode.
+         *
+         * Declares a focused group of tests that could be run in parallel. This is similar to
+         * [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel), but
+         * focuses the group. If there are some focused tests or suites, all of them will be run but nothing else.
+         *
+         * **Usage**
+         *
+         * ```js
+         * test.describe.parallel.only('group', () => {
+         *   test('runs in parallel 1', async ({ page }) => {});
+         *   test('runs in parallel 2', async ({ page }) => {});
+         * });
+         * ```
+         *
+         * @param title Group title.
+         * @param callback A callback that is run immediately when calling
+         * [test.describe.parallel.only(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel-only).
+         * Any tests added in this callback will belong to the group.
+         */
+        only: SuiteFunction;
+    };
+    /**
+     * Configures the enclosing scope. Can be executed either on the top level or inside a describe. Configuration applies
+     * to the entire scope, regardless of whether it run before or after the test declaration.
+     *
+     * Learn more about the execution modes [here](https://playwright.dev/docs/test-parallel).
+     *
+     * **Usage**
+     * - Running tests in parallel.
+     *
+     *   ```js
+     *   // Run all the tests in the file concurrently using parallel workers.
+     *   test.describe.configure({ mode: 'parallel' });
+     *   test('runs in parallel 1', async ({ page }) => {});
+     *   test('runs in parallel 2', async ({ page }) => {});
+     *   ```
+     *
+     * - Running tests serially, retrying from the start.
+     *
+     *   **NOTE** Running serially is not recommended. It is usually better to make your tests isolated, so they can be
+     *   run independently.
+     *
+     *   ```js
+     *   // Annotate tests as inter-dependent.
+     *   test.describe.configure({ mode: 'serial' });
+     *   test('runs first', async ({ page }) => {});
+     *   test('runs second', async ({ page }) => {});
+     *   ```
+     *
+     * - Configuring retries and timeout for each test.
+     *
+     *   ```js
+     *   // Each test in the file will be retried twice and have a timeout of 20 seconds.
+     *   test.describe.configure({ retries: 2, timeout: 20_000 });
+     *   test('runs first', async ({ page }) => {});
+     *   test('runs second', async ({ page }) => {});
+     *   ```
+     *
+     * - Run multiple describes in parallel, but tests inside each describe in order.
+     *
+     *   ```js
+     *   test.describe.configure({ mode: 'parallel' });
+     *
+     *   test.describe('A, runs in parallel with B', () => {
+     *     test.describe.configure({ mode: 'default' });
+     *     test('in order A1', async ({ page }) => {});
+     *     test('in order A2', async ({ page }) => {});
+     *   });
+     *
+     *   test.describe('B, runs in parallel with A', () => {
+     *     test.describe.configure({ mode: 'default' });
+     *     test('in order B1', async ({ page }) => {});
+     *     test('in order B2', async ({ page }) => {});
+     *   });
+     *   ```
+     *
+     * @param options
+     */
+    configure: (options: { mode?: 'default' | 'parallel' | 'serial', retries?: number, timeout?: number }) => void;
+}

package/src/api/SuiteFunction.ts

@@ -0,0 +1,52 @@
+// Playwright Test doesn't export all its public APIs, hence the need for this workaround
+// See https://github.com/microsoft/playwright/pull/24146
+export interface SuiteFunction {
+    /**
+     * Declares a group of tests.
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe('two tests', () => {
+     *   test('one', async ({ page }) => {
+     *     // ...
+     *   });
+     *
+     *   test('two', async ({ page }) => {
+     *     // ...
+     *   });
+     * });
+     * ```
+     *
+     * @param title Group title.
+     * @param callback A callback that is run immediately when calling
+     * [test.describe(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-1). Any tests added in
+     * this callback will belong to the group.
+     */
+    (title: string, callback: () => void): void;
+    /**
+     * Declares an anonymous group of tests. This is convenient to give a group of tests a common option with
+     * [test.use(options)](https://playwright.dev/docs/api/class-test#test-use).
+     *
+     * **Usage**
+     *
+     * ```js
+     * test.describe(() => {
+     *   test.use({ colorScheme: 'dark' });
+     *
+     *   test('one', async ({ page }) => {
+     *     // ...
+     *   });
+     *
+     *   test('two', async ({ page }) => {
+     *     // ...
+     *   });
+     * });
+     * ```
+     *
+     * @param callback A callback that is run immediately when calling
+     * [test.describe(callback)](https://playwright.dev/docs/api/class-test#test-describe-2). Any tests added in this
+     * callback will belong to the group.
+     */
+    (callback: () => void): void;
+}

package/src/api/index.ts

@@ -1,4 +1,6 @@
+export * from './DescribeFunction';
 export * from './PlaywrightTestConfig';
 export * from './SerenityFixtures';
 export * from './SerenityOptions';
+export * from './SuiteFunction';
 export * from './test-api';

package/src/api/test-api.ts

@@ -7,7 +7,7 @@ import type {
     TestInfo,
     TestType,
 } from '@playwright/test';
-import { test as playwrightBaseTest, } from '@playwright/test';
+import { test as playwrightBaseTest } from '@playwright/test';
 import { AnsiDiffFormatter, Cast, Duration, serenity as serenityInstance, TakeNotes } from '@serenity-js/core';
 import { SceneFinishes, SceneTagged } from '@serenity-js/core/lib/events';
 import { BrowserTag, PlatformTag } from '@serenity-js/core/lib/model';
@@ -22,6 +22,7 @@ import {
     PlaywrightStepReporter,
     SERENITY_JS_DOMAIN_EVENTS_ATTACHMENT_CONTENT_TYPE
 } from '../reporter';
+import type { DescribeFunction } from './DescribeFunction';
 import { PerformActivitiesAsPlaywrightSteps } from './PerformActivitiesAsPlaywrightSteps';
 import type { SerenityFixtures } from './SerenityFixtures';
 import type { SerenityOptions } from './SerenityOptions';
@@ -185,7 +186,7 @@ export type TestApi<TestArgs extends Record<string, any>, WorkerArgs extends Rec
         useFixtures: <T extends Record<string, any>, W extends Record<string, any> = object>(customFixtures: Fixtures<T, W, TestArgs, WorkerArgs>) => TestApi<TestArgs & T, WorkerArgs & W>,
         it: TestType<TestArgs, WorkerArgs>,
         test: TestType<TestArgs, WorkerArgs>,
-        describe: typeof playwrightBaseTest.describe,
+        describe: DescribeFunction,
     }
 
 function createTestApi<TestArgs extends Record<string, any>, WorkerArgs extends Record<string, any> = object>(baseTest: TestType<TestArgs, WorkerArgs>): TestApi<TestArgs, WorkerArgs> {
@@ -318,7 +319,7 @@ export const test = api.test;
  * - [Playwright Test `describe` function](https://playwright.dev/docs/api/class-test#test-describe-1)
  * - [Serenity/JS + Playwright Test project template](https://github.com/serenity-js/serenity-js-playwright-test-template/)
  */
-export const describe: typeof playwrightBaseTest.describe = api.describe;
+export const describe = api.describe;
 
 export const beforeAll = api.beforeAll;