@serenity-js/playwright-test 3.31.17 → 3.32.1

package/lib/api/serenity-fixtures.d.ts

@@ -0,0 +1,377 @@
+import type { Cast, ClassDescription, Duration, Serenity, StageCrewMember, StageCrewMemberBuilder } from '@serenity-js/core';
+import type { Actor } from '@serenity-js/core';
+import type { ExtraBrowserContextOptions } from '@serenity-js/playwright';
+/**
+ * Serenity/JS-specific [Playwright Test fixtures](https://playwright.dev/docs/test-fixtures)
+ * injected into your [test scenarios](https://serenity-js.org/api/playwright-test/function/it/).
+ *
+ * ### Configuring Serenity/JS using a test file
+ *
+ * ```typescript
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { describe, it, test } from '@serenity-js/playwright-test'
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
+ *
+ * describe(`Recording items`, () => {
+ *
+ *     test.use({
+ *         defaultActorName: 'Serena',
+ *         crew: [
+ *             Photographer.whoWill(TakePhotosOfFailures),
+ *         ],
+ *
+ *         // Register a custom cast of Serenity/JS actors to replace the default one
+ *         actors: async ({ browser, contextOptions, extraContextOptions, baseURL }, use) => {
+ *              const cast = Cast.where(actor =>
+ *                  actor.whoCan(
+ *                      BrowseTheWebWithPlaywright.using(browser, contextOptions, extraContextOptions),
+ *                      TakeNotes.usingAnEmptyNotepad(),
+ *                      CallAnApi.at(baseURL),
+ *                  )
+ *              )
+ *
+ *              await use(cast)
+ *         },
+ *     })
+ *
+ *     describe(`Todo List App`, () => {
+ *
+ *         it(`should allow me to add a todo item`, async ({ actor }) => {
+ *             await actor.attemptsTo(
+ *                 startWithAnEmptyList(),
+ *
+ *                 recordItem('Buy some milk'),
+ *
+ *                 Ensure.that(itemNames(), equals([
+ *                     'Buy some milk',
+ *                 ])),
+ *             )
+ *         })
+ *     })
+ * })
+ * ```
+ *
+ * ### Configuring Serenity/JS using Playwright configuration file
+ *
+ * ```typescript
+ * // playwright.config.ts
+ * import { defineConfig } from '@playwright/test'
+ * import type { Cast, TakeNotes } from '@serenity-js/core'
+ * import type { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+ * import type { SerenityFixtures, SerenityWorkerFixtures } from '@serenity-js/playwright-test'
+ * import type { CallAnApi } from '@serenity-js/rest'
+ *
+ * export default defineConfig<SerenityFixtures & MyCustomOptions, SerenityWorkerFixtures> = {
+ *
+ *     // Register Serenity/JS reporter for Playwright Test
+ *     // to enable integration with Serenity/JS stage crew members
+ *     // and have them instantiated in the Playwright reporter process
+ *     reporter: [
+ *         [ '@serenity-js/playwright-test', {
+ *             // Stage crew members instantiated in the test reporter process
+ *             crew: [
+ *                 '@serenity-js/serenity-bdd',
+ *                 '@serenity-js/console-reporter',
+ *                 [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *             ]
+ *         }]
+ *     ],
+ *
+ *     use: {
+ *
+ *         // Register Serenity/JS stage crew members
+ *         // and have them instantiated in Playwright Test worker processes
+ *         crew: [
+ *             [ '@serenity-js/web:Photographer', { strategy: 'TakePhotosOfFailures' } ]
+ *         ],
+ *
+ *         // Name to be given to an actor injected via `actor` fixture
+ *         defaultActorName: 'Alice',
+ *
+ *         // Any other Playwright options
+ *         baseURL: 'https://todo-app.serenity-js.org/',
+ *         video: 'on-first-retry',
+ *         trace: 'on-first-retry',
+ *     },
+ * })
+ * ```
+ *
+ * ## Learn more
+ * - [Using Serenity/JS with Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test/)
+ * - [`PlaywrightTestConfig`](https://serenity-js.org/api/playwright-test/#PlaywrightTestConfig)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ * - [`SerenityFixtures`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/)
+ */
+export interface SerenityFixtures {
+    /**
+     * Configures the name given to the default Serenity/JS [`actor`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actor)
+     * injected into a [test scenario](https://serenity-js.org/api/playwright-test/function/it/).
+     *
+     * #### Learn more
+     * - Declaring a Serenity/JS [test scenario](https://serenity-js.org/api/playwright-test/function/it/)
+     * - [`SerenityFixtures`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/)
+     */
+    defaultActorName: string;
+    /**
+     * Configures the [stage crew members](https://serenity-js.org/api/core/class/SerenityConfig/#crew)
+     * to be instantiated in Playwright Test worker processes.
+     *
+     * :::info Did you know?
+     * By default, Serenity/JS registers a [`Photographer`](https://serenity-js.org/api/web/class/Photographer/).whoWill([`TakePhotosOfFailures`](https://serenity-js.org/api/web/class/TakePhotosOfFailures/)),
+     * so that any test failures are automatically accompanied by a screenshot.
+     *
+     * If you prefer a different behaviour, you can configure the `crew` with an empty array to disable taking screenshots altogether (`crew: []`),
+     * or with a [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) who uses a different [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/), like to [`TakePhotosOfInteractions`](https://serenity-js.org/api/web/class/TakePhotosOfInteractions/).
+     * :::
+     *
+     * #### Example
+     *
+     * ```typescript
+     * // playwright.config.ts
+     * import type { SerenityFixtures, SerenityWorkerFixtures } from '@serenity-js/playwright-test'
+     * import { defineConfig } from '@playwright/test'
+     *
+     * export default defineConfig<SerenityFixtures, SerenityWorkerFixtures>({
+     *     use: {
+     *         crew: [
+     *             [ '@serenity-js/web:Photographer', { strategy: 'TakePhotosOfFailures' } ]
+     *         ],
+     *     },
+     * });
+     * ```
+     *
+     * #### Learn more
+     * - [`SerenityConfig.crew`](https://serenity-js.org/api/core/class/SerenityConfig/#crew)
+     */
+    crew: Array<ClassDescription | StageCrewMember | StageCrewMemberBuilder>;
+    /**
+     * Sets the [`cueTimeout`](https://serenity-js.org/api/core/class/SerenityConfig/#cueTimeout) to a given [duration](https://serenity-js.org/api/core/class/Duration/) or a numeric value in milliseconds.
+     * Defaults to **5 seconds**.
+     *
+     * #### Learn more
+     * - [`SerenityConfig.cueTimeout`](https://serenity-js.org/api/core/class/SerenityConfig/#cueTimeout)
+     * - [`Discardable`](https://serenity-js.org/api/core/interface/Discardable/)
+     * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+     */
+    cueTimeout: number | Duration;
+    /**
+     * The maximum default amount of time allowed for interactions such as [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until)
+     * to complete.
+     *
+     * Defaults to **5 seconds**, can be overridden per interaction.
+     *
+     * #### Learn more
+     * - [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until)
+     */
+    interactionTimeout: number | Duration;
+    /**
+     * Convenience properties to be used with the [ability](https://serenity-js.org/api/core/class/Ability/)
+     * to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/),
+     * in addition to Playwright [BrowserContextOptions](https://playwright.dev/docs/api/class-testoptions#test-options-context-options):
+     *
+     * - [`defaultNavigationTimeout`](https://serenity-js.org/api/playwright/interface/ExtraBrowserContextOptions/#defaultNavigationTimeout)
+     * - [`defaultNavigationWaitUntil`](https://serenity-js.org/api/playwright/interface/ExtraBrowserContextOptions/#defaultNavigationWaitUntil)
+     * - [`defaultTimeout`](https://serenity-js.org/api/playwright/interface/ExtraBrowserContextOptions/#defaultTimeout)
+     *
+     * #### Using `extraContextOptions` with the default cast of Serenity/JS actors
+     *
+     * ```typescript
+     * // playwright.config.ts
+     * import type { SerenityFixtures, SerenityWorkerFixtures } from '@serenity-js/playwright-test'
+     * import { defineConfig } from '@playwright/test'
+     *
+     * export default defineConfig<SerenityFixtures, SerenityWorkerFixtures>({
+     *     use: {
+     *         extraContextOptions: {
+     *             defaultNavigationTimeout: 30_000,
+     *         }
+     *
+     *         // Since `actors` property is not defined,
+     *         // `extraContextOptions` will be passed to the default cast of Serenity/JS actors
+     *         // and injected into the ability to `BrowseTheWebWithPlaywright`
+     *         // that each actor receives.
+     *     },
+     * })
+     * ```
+     *
+     * #### Using `extraContextOptions` with a custom cast of Serenity/JS actors
+     *
+     * ```typescript
+     * // playwright.config.ts
+     * import type { SerenityFixtures, SerenityWorkerFixtures } from '@serenity-js/playwright-test'
+     * import { defineConfig } from '@playwright/test'
+     *
+     * export default defineConfig<SerenityFixtures, SerenityWorkerFixtures>({
+     *     use: {
+     *         extraContextOptions: {
+     *             defaultNavigationTimeout: 30_000,
+     *         }
+     *
+     *         // Custom cast of actors receives the default `contextOptions` and
+     *         // the `extraContextOptions` with the additional Serenity/JS properties.
+     *         actors: async ({ browser, contextOptions, extraContextOptions }, use) => {
+     *             const cast = Cast.where(actor => actor.whoCan(
+     *                 BrowseTheWebWithPlaywright.using(browser, contextOptions, extraContextOptions),
+     *                 TakeNotes.usingAnEmptyNotepad(),
+     *             ))
+     *
+     *             await use(cast)
+     *         },
+     *     },
+     * })
+     * ```
+     *
+     * #### Learn more
+     * - [`SerenityFixtures`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/)
+     * - [Playwright Browser Context options](https://playwright.dev/docs/api/class-testoptions#test-options-context-options)
+     * - [Playwright Test fixtures](https://playwright.dev/docs/test-fixtures)
+     */
+    extraContextOptions: Partial<ExtraBrowserContextOptions>;
+    /**
+     * A cast of Serenity/JS actors to be used instead of the default cast
+     * when instantiating [`actor`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actor)
+     * and invoking [`actorCalled`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actorCalled).
+     *
+     * :::info Did you know?
+     * When you use `@serenity-js/playwright-test` [test APIs](https://serenity-js.org/api/playwright-test/function/it/), Serenity/JS already provides a default cast of actors for you.
+     * Each one of the default actors receives [abilities](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/) and [`TakeNotes.usingAnEmptyNotepad`](https://serenity-js.org/api/core/class/TakeNotes/#usingAnEmptyNotepad).
+     *
+     * The default abilities should be sufficient in most web testing scenarios. However, you might want to override this default configuration
+     * when you need your actors to [interact with REST APIs](https://serenity-js.org/api/rest/class/CallAnApi/),
+     * [manage local servers](https://serenity-js.org/api/local-server/class/ManageALocalServer/),
+     * start with a notepad that has some [initial state](https://serenity-js.org/api/core/class/TakeNotes/#using),
+     * or receive [custom abilities](https://serenity-js.org/api/core/class/Ability/).
+     * :::
+     *
+     *
+     * #### Overriding the default cast of Serenity/JS actors
+     *
+     * ```typescript
+     * import { Cast, TakeNotes } from '@serenity-js/core'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     * import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+     * import { describe, it, test } from '@serenity-js/playwright-test'
+     *
+     * describe(`Recording items`, () => {
+     *
+     *     test.use({
+     *         extraContextOptions: {
+     *             defaultNavigationTimeout: 30_000,
+     *         },
+     *
+     *         defaultActorName: 'Serena',
+     *         actors: async ({ browser, contextOptions, extraContextOptions }, use) => {
+     *             const cast = Cast.where(actor =>
+     *                 actor.whoCan(
+     *                     BrowseTheWebWithPlaywright.using(browser, contextOptions, extraContextOptions),
+     *                     TakeNotes.usingAnEmptyNotepad(),
+     *                 )
+     *             )
+     *
+     *             // Make sure to pass your custom cast to Playwright `use` callback
+     *             await use(cast)
+     *         },
+     *     })
+     *
+     *     describe(`Todo List App`, () => {
+     *
+     *         it(`should allow me to add a todo item`, async ({ actor }) => {
+     *             await actor.attemptsTo(
+     *                 startWithAnEmptyList(),
+     *
+     *                 recordItem('Buy some milk'),
+     *
+     *                 Ensure.that(itemNames(), equals([
+     *                     'Buy some milk',
+     *                 ])),
+     *             )
+     *         })
+     *     })
+     * })
+     *
+     *
+     * #### Learn more
+     * - Declaring a Serenity/JS [test scenario](https://serenity-js.org/api/playwright-test/function/it/)
+     * - [`SerenityFixtures`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/)
+     */
+    actors: Cast;
+    /**
+     * Default [`actor`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actor) injected into a [test scenario](https://serenity-js.org/api/playwright-test/function/it/).
+     *
+     * Using `actor` fixture is equivalent to invoking [`actorCalled`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actorCalled)
+     * with [`defaultActorName`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#defaultActorName).
+     *
+     * #### Learn more
+     * - [`actorCalled`](https://serenity-js.org/api/playwright-test/interface/SerenityWorkerFixtures/#actorCalled)
+     * - [`defaultActorName`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#defaultActorName)
+     * - Declaring a Serenity/JS [test scenario](https://serenity-js.org/api/playwright-test/function/it/)
+     */
+    actor: Actor;
+}
+/**
+ * Serenity/JS-specific [Playwright Test fixtures](https://playwright.dev/docs/test-fixtures)
+ * injected into your [test scenarios](https://serenity-js.org/api/playwright-test/function/it/).
+ *
+ * ## Example test scenario
+ *
+ * ```typescript
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { describe, it, test } from '@serenity-js/playwright-test'
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
+ *
+ * describe(`Recording items`, () => {
+ *
+ *     test.use({
+ *         defaultActorName: 'Serena',
+ *         crew: [
+ *             Photographer.whoWill(TakePhotosOfFailures),
+ *         ],
+ *     })
+ *
+ *     describe(`Todo List App`, () => {
+ *
+ *         it(`should allow me to add a todo item`, async ({ actor }) => {
+ *             await actor.attemptsTo(
+ *                 startWithAnEmptyList(),
+ *
+ *                 recordItem('Buy some milk'),
+ *
+ *                 Ensure.that(itemNames(), equals([
+ *                     'Buy some milk',
+ *                 ])),
+ *             )
+ *         })
+ *     })
+ * })
+ * ```
+ *
+ * ## Learn more
+ * - [Using Serenity/JS with Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test/)
+ */
+export interface SerenityWorkerFixtures {
+    /**
+     * Name and version of the operating system that Playwright Test worker process runs on.
+     */
+    platform: {
+        name: string;
+        version: string;
+    };
+    /**
+     * Retrieves the root object of the Serenity/JS framework.
+     */
+    serenity: Serenity;
+    /**
+     * Uses the provided [cast](https://serenity-js.org/api/core/class/Cast/) of [`actors`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actors) to instantiate an [`Actor`](https://serenity-js.org/api/core/class/Actor/) called `name`
+     * and inject it into a [test scenario](https://serenity-js.org/api/playwright-test/function/it/).
+     *
+     * Retrieves an existing actor if one has already been instantiated.
+     *
+     * #### Learn more
+     * - Declaring a Serenity/JS [test scenario](https://serenity-js.org/api/playwright-test/function/it/)
+     * - [`SerenityFixtures.actors`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actors)
+     *
+     * @param name
+     */
+    actorCalled: (name: string) => Actor;
+}
+//# sourceMappingURL=serenity-fixtures.d.ts.map

package/lib/api/serenity-fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serenity-fixtures.d.ts","sourceRoot":"","sources":["../../src/api/serenity-fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,IAAI,EACJ,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,sBAAsB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;AACH,MAAM,WAAW,gBAAgB;IAE7B;;;;;;;OAOG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,EAAE,KAAK,CAAC,gBAAgB,GAAG,eAAe,GAAG,sBAAsB,CAAC,CAAC;IAEzE;;;;;;;;OAQG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9B;;;;;;;;OAQG;IACH,kBAAkB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IACH,mBAAmB,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,MAAM,EAAE,IAAI,CAAC;IAEb;;;;;;;;;;OAUG;IACH,KAAK,EAAE,KAAK,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;;;;;;;;;OAWG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAC;CACxC"}

package/lib/api/{SerenityOptions.js → serenity-fixtures.js}

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

package/lib/api/serenity-fixtures.js.map

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

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

@@ -1,7 +1,18 @@
 import type { Expect, Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestInfo, TestType } from '@playwright/test';
-import type { SerenityFixtures } from './SerenityFixtures';
-import type { SerenityOptions } from './SerenityOptions';
-export declare const fixtures: Fixtures<Omit<SerenityOptions, 'actors'> & SerenityFixtures, object, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+import type { DiffFormatter } from '@serenity-js/core';
+import { PlaywrightTestSceneIdFactory } from '../reporter/PlaywrightTestSceneIdFactory';
+import type { SerenityFixtures, SerenityWorkerFixtures } from './serenity-fixtures';
+import { WorkerEventStreamWriter } from './WorkerEventStreamWriter';
+interface SerenityInternalFixtures {
+    configureScenarioInternal: void;
+}
+interface SerenityInternalWorkerFixtures {
+    configureWorkerInternal: void;
+    sceneIdFactoryInternal: PlaywrightTestSceneIdFactory;
+    diffFormatterInternal: DiffFormatter;
+    eventStreamWriterInternal: WorkerEventStreamWriter;
+}
+export declare const fixtures: Fixtures<SerenityFixtures & SerenityInternalFixtures, SerenityWorkerFixtures & SerenityInternalWorkerFixtures, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 /**
  * Serenity/JS BDD-style test API created by [`useBase`](https://serenity-js.org/api/playwright-test/function/useBase/).
  */
@@ -91,11 +102,11 @@ export type TestApi<TestArgs extends Record<string, any>, WorkerArgs extends Rec
  * - [Playwright Test `test` function](https://playwright.dev/docs/api/class-test#test-call)
  * - [Serenity/JS + Playwright Test project template](https://github.com/serenity-js/serenity-js-playwright-test-template/)
  */
-export declare const it: TestType<PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions & object>;
+export declare const it: TestType<PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures>;
 /**
  * Declares a single test scenario. Alias for [`it`](https://serenity-js.org/api/playwright-test/function/it/).
  */
-export declare const test: TestType<PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions & object>;
+export declare const test: TestType<PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures>;
 /**
  * Declares a group of test scenarios.
  *
@@ -180,23 +191,23 @@ export declare const describe: {
     }) => void;
 };
 export declare const beforeAll: {
-    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
-    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
 };
 export declare const beforeEach: {
-    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
-    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
 };
 export declare const afterEach: {
-    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
-    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
 };
 export declare const afterAll: {
-    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
-    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & Omit<SerenityOptions, "actors"> & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & object, testInfo: TestInfo) => Promise<any> | any): void;
+    (inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
+    (title: string, inner: (args: PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures, testInfo: TestInfo) => Promise<any> | any): void;
 };
 export declare const expect: 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>;
+export declare const useFixtures: <T extends Record<string, any>, W extends Record<string, any> = object>(customFixtures: Fixtures<T, W, PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures>) => TestApi<PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures & T, PlaywrightWorkerArgs & PlaywrightWorkerOptions & SerenityWorkerFixtures & W>;
 /**
  * Creates a Serenity/JS BDD-style test API around the given Playwright [base test](https://playwright.dev/docs/test-fixtures).
  *
@@ -335,5 +346,6 @@ export declare const useFixtures: <T extends Record<string, any>, W extends Reco
  *
  * @param baseTest
  */
-export declare function useBase<TestArgs extends Record<string, any>, WorkerArgs extends Record<string, any> = object>(baseTest: TestType<TestArgs, WorkerArgs>): TestApi<Omit<SerenityOptions, 'actors'> & SerenityFixtures & TestArgs, WorkerArgs>;
+export declare function useBase<BaseTestFixtures extends (PlaywrightTestArgs & PlaywrightTestOptions), BaseWorkerFixtures extends (PlaywrightWorkerArgs & PlaywrightWorkerOptions)>(baseTest: TestType<BaseTestFixtures, BaseWorkerFixtures>): TestApi<BaseTestFixtures & SerenityFixtures, BaseWorkerFixtures & SerenityWorkerFixtures>;
+export {};
 //# sourceMappingURL=test-api.d.ts.map

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,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACR,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAkB1B,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,CAiIrL,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,UAAU,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC,GACnH;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;CACxC,CAAA;AAoBL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,EAAE,oKAAS,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,IAAI,oKAAW,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAkNqk+H,CAAC;eAA4C,CAAC;eAAiB,CAAC;;CAlNtn+H,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,EAAE,MAAmB,CAAC;AAEzC,eAAO,MAAM,WAAW,GAnJF,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,iXAmJxC,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":"AAIA,OAAO,KAAK,EACR,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACR,QAAQ,EAEX,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAWvD,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AAExF,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,UAAU,wBAAwB;IAC9B,yBAAyB,EAAE,IAAI,CAAC;CACnC;AAED,UAAU,8BAA8B;IACpC,uBAAuB,EAAE,IAAI,CAAC;IAC9B,sBAAsB,EAAE,4BAA4B,CAAC;IACrD,qBAAqB,EAAE,aAAa,CAAC;IACrC,yBAAyB,EAAE,uBAAuB,CAAC;CACtD;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,gBAAgB,GAAG,wBAAwB,EAAE,sBAAsB,GAAG,8BAA8B,EAAE,kBAAkB,GAAG,qBAAqB,EAAE,oBAAoB,GAAG,uBAAuB,CAyM/N,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,UAAU,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC,GACnH;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,EAC/E,cAAc,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,KACnD,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC;IAE3C,EAAE,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACnC,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CACxC,CAAA;AAoBL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,EAAE,kJAAS,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,IAAI,kJAAW,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAoNy42H,CAAC;eAA4C,CAAC;eAAiB,CAAC;;CApN172H,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,EAAE,MAAmB,CAAC;AAEzC,eAAO,MAAM,WAAW,GAtJF,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,6UAsJxC,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyIG;AACH,wBAAgB,OAAO,CACnB,gBAAgB,SAAS,CAAC,kBAAkB,GAAG,qBAAqB,CAAC,EACrE,kBAAkB,SAAS,CAAC,oBAAoB,GAAG,uBAAuB,CAAC,EAC5E,QAAQ,EAAE,QAAQ,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,GAAG,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,EAAE,kBAAkB,GAAG,sBAAsB,CAAC,CAItJ"}