@serenity-js/playwright-test 3.0.0-rc.38 → 3.0.0-rc.39

package/src/reporter/SerenityReporterForPlaywrightTest.ts

@@ -1,6 +1,6 @@
 import type { FullConfig, TestError } from '@playwright/test';
 import type { Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
-import { LogicError, Serenity, serenity as reporterSerenityInstance, StageCrewMember, StageCrewMemberBuilder, Timestamp } from '@serenity-js/core';
+import { ClassDescription, LogicError, Serenity, serenity as reporterSerenityInstance, StageCrewMember, StageCrewMemberBuilder, Timestamp } from '@serenity-js/core';
 import { OutputStream } from '@serenity-js/core/lib/adapter';
 import * as events from '@serenity-js/core/lib/events';
 import {
@@ -34,25 +34,39 @@ import {
 
 import { SERENITY_JS_DOMAIN_EVENTS_ATTACHMENT_CONTENT_TYPE } from './PlaywrightAttachments';
 
-// TODO Split SerenityConfig into ActorsConfig and SerenityReportingConfig
-export class SerenityReporterForPlaywrightTestConfig {
+/**
+ * Configuration object accepted by `@serenity-js/playwright-test` reporter.
+ *
+ * See {@apilink SerenityOptions} for usage examples.
+ */
+export interface SerenityReporterForPlaywrightTestConfig {
+
     /**
      * A list of {@apilink StageCrewMemberBuilder|StageCrewMemberBuilders} or {@apilink StageCrewMember|StageCrewMembers}
-     * to be notified of {@apilink DomainEvent|DomainEvents} that occur during the scenario execution.
+     * to be instantiated in Playwright Test reporter process and notified of {@apilink DomainEvent|DomainEvents} that occur during the scenario execution.
+     * Note that the `crew` can also be configured using {@apilink ClassDescription|ClassDescriptions}.
+     *
+     * #### Learn more
+     * - {@apilink SerenityOptions}
+     * - {@apilink SerenityConfig.crew}
      */
-    crew?: Array<StageCrewMember | StageCrewMemberBuilder>;
+    crew?: Array<StageCrewMember | StageCrewMemberBuilder | ClassDescription>;
 
     /**
      * An output stream to be injected into {@apilink StageCrewMemberBuilder|StageCrewMemberBuilders}
      *
      * Defaults to [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout).
+     *
+     * #### Learn more
+     * - {@apilink SerenityConfig.outputStream}
      */
     outputStream?: OutputStream;
 }
 
 /**
- * Receives notifications from Playwright Test and translates them to Serenity/JS
- * {@apilink DomainEvent|domain events}, so that they can be used with Serenity/JS reporters.
+ * Serenity/JS reporter that receives notifications from Playwright Test and emits them as
+ * Serenity/JS {@apilink DomainEvent|domain events} which can be used by
+ * Serenity/JS {@apilink StageCrewMember|stage crew members}.
  */
 export class SerenityReporterForPlaywrightTest implements Reporter {
 
@@ -60,7 +74,6 @@ export class SerenityReporterForPlaywrightTest implements Reporter {
     private sceneIds: Map<string, CorrelationId> = new Map();
 
     /**
-     *
      * @param config
      * @param serenity
      *  Instance of {@apilink Serenity}, specific to the Node process running this Serenity reporter.

package/lib/PlaywrightTestConfig.d.ts

@@ -1,8 +0,0 @@
-import type { PlaywrightTestConfig as BasePlaywrightTestConfig } from '@playwright/test';
-import { ClassDescription } from '@serenity-js/core';
-export type PlaywrightTestConfig<BaseConfig extends BasePlaywrightTestConfig = BasePlaywrightTestConfig> = Omit<BaseConfig, 'use' | 'reporter'> & {
-    use?: BaseConfig['use'] & {
-        crew: Array<ClassDescription>;
-    };
-};
-//# sourceMappingURL=PlaywrightTestConfig.d.ts.map

package/lib/PlaywrightTestConfig.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlaywrightTestConfig.d.ts","sourceRoot":"","sources":["../src/PlaywrightTestConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,IAAI,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,MAAM,MAAM,oBAAoB,CAAC,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,IAAI,IAAI,CAAC,UAAU,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAC9I,GAAG,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG;QAAE,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;KAAE,CAAA;CAC9D,CAAC"}

package/lib/PlaywrightTestConfig.js.map

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

package/lib/api.d.ts

@@ -1,213 +0,0 @@
-import { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from '@playwright/test';
-import { Actor, Cast, Duration, Serenity, StageCrewMember } from '@serenity-js/core';
-/**
- * Serenity/JS-specific [Playwright Test fixtures](https://playwright.dev/docs/test-fixtures).
- *
- * ## 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
- * - Declaring a test scenario using {@apilink it}
- * - Grouping test scenarios using {@apilink describe}
- * - [Serenity/JS + Playwright Test project template](https://github.com/serenity-js/serenity-js-playwright-test-template/)
- */
-export interface SerenityFixtures {
-    /**
-     * Configures the {@apilink Cast} of {@apilink SerenityConfig.actors|actors} to be used when injecting an {@apilink SerenityFixtures.actor|actor}
-     * or invoking {@apilink SerenityFixtures.actorCalled|actorCalled} in a {@apilink it|test scenario}.
-     *
-     * #### Learn more
-     * - Declaring a test scenario using {@apilink it}
-     */
-    actors: Cast;
-    /**
-     * Configures the {@apilink SerenityConfig.crew|stage crew}
-     */
-    crew: StageCrewMember[];
-    /**
-     * Configures the {@apilink SerenityConfig.cueTimeout|cueTimeout}
-     */
-    cueTimeout: Duration;
-    /**
-     * Retrieves the root object of the Serenity/JS framework.
-     */
-    serenity: Serenity;
-    /**
-     * Name and version of the operating system the Playwright Test runs on.
-     */
-    platform: {
-        name: string;
-        version: string;
-    };
-    /**
-     * Uses the provided {@apilink Cast} of {@apilink SerenityFixtures.actors|actors} to instantiate an {@apilink Actor} called `name`
-     * and inject it into a {@apilink it|test scenario}.
-     * Retrieves an existing actor if one has already been instantiated.
-     *
-     * #### Learn more
-     * - Declaring a test scenario using {@apilink it}
-     *
-     * @param name
-     */
-    actorCalled: (name: string) => Actor;
-    /**
-     * Configures the name given to the default {@apilink SerenityFixtures.actor|actor} injected into the {@apilink it|test scenario}.
-     *
-     * #### Learn more
-     * - Declaring a test scenario using {@apilink it}
-     */
-    defaultActorName: string;
-    /**
-     * Default {@apilink SerenityFixtures.actor|actor} injected into a {@apilink it|test scenario}.
-     *
-     * #### Learn more
-     * - {@apilink SerenityFixtures.actorCalled|actorCalled}
-     * - Declaring a test scenario using {@apilink it}
-     */
-    actor: Actor;
-}
-export type SerenityTestType = TestType<PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
-/**
- * Declares a single test scenario.
- *
- * ## Example
- *
- * ```typescript
- * import { Ensure, equals } from '@serenity-js/assertions'
- * import { describe, it } from '@serenity-js/playwright-test'
- *
- * 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',
- *             ])),
- *         )
- *     })
- *
- *     it('supports multiple actors using separate browsers', async ({ actorCalled }) => {
- *         await actorCalled('Alice').attemptsTo(
- *             startWithAListContaining(
- *                 'Feed the cat'
- *             ),
- *         )
- *
- *         await actorCalled('Bob').attemptsTo(
- *             startWithAListContaining(
- *                 'Walk the dog'
- *             ),
- *         )
- *
- *         await actorCalled('Alice').attemptsTo(
- *             Ensure.that(itemNames(), equals([
- *                 'Feed the cat'
- *             ])),
- *         )
- *
- *         await actorCalled('Bob').attemptsTo(
- *             Ensure.that(itemNames(), equals([
- *                 'Walk the dog'
- *             ])),
- *         )
- *     })
- * })
- * ```
- *
- * ## Learn more
- * - Grouping test scenarios using {@apilink describe}
- * - {@apilink SerenityFixtures}
- * - [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: SerenityTestType;
-export declare const test: SerenityTestType;
-/**
- * Declares a group of test scenarios.
- *
- * ## Example
- *
- * ```typescript
- * import { Ensure, equals } from '@serenity-js/assertions'
- * import { describe, it, test } from '@serenity-js/playwright-test'
- * import { Photographer, TakePhotosOfFailures, Value } from '@serenity-js/web'
- *
- * describe(`Todo List App`, () => {
- *
- *     test.use({
- *         defaultActorName: 'Serena',
- *         crew: [
- *             Photographer.whoWill(TakePhotosOfFailures),
- *         ],
- *     })
- *
- *     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',
- *             ])),
- *         )
- *     })
- *
- *     it('should clear text input field when an item is added', async ({ actor }) => {
- *         await actor.attemptsTo(
- *             startWithAnEmptyList(),
- *
- *             recordItem('Buy some milk'),
- *
- *             Ensure.that(Value.of(newTodoInput()), equals('')),
- *         )
- *     })
- * })
- * ```
- *
- * ## Learn more
- * - Declaring a test scenario using {@apilink it}
- * - [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: SerenityTestType['describe'];
-export declare const beforeAll: SerenityTestType['beforeAll'];
-export declare const beforeEach: SerenityTestType['beforeEach'];
-export declare const afterEach: SerenityTestType['afterEach'];
-export declare const afterAll: SerenityTestType['afterAll'];
-export declare const expect: SerenityTestType['expect'];
-//# sourceMappingURL=api.d.ts.map

package/lib/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,uBAAuB,EAA0B,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC9J,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAgC,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASnH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,gBAAgB;IAE7B;;;;;;OAMG;IACH,MAAM,EAAE,IAAI,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,QAAQ,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAE5C;;;;;;;;;OASG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAC;IAErC;;;;;OAKG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;;;OAMG;IACH,KAAK,EAAE,KAAK,CAAC;CAChB;AAED,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,kBAAkB,GAAG,qBAAqB,GAAG,gBAAgB,EAAE,oBAAoB,GAAG,uBAAuB,CAAC,CAAC;AAEvJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,EAAE,EAAE,gBAyFf,CAAC;AAEH,eAAO,MAAM,IAAI,EAAE,gBAAqB,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAe,CAAC;AAClE,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAgB,CAAC;AACrE,eAAO,MAAM,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAiB,CAAC;AACxE,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAgB,CAAC;AACrE,eAAO,MAAM,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAe,CAAC;AAClE,eAAO,MAAM,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAa,CAAC"}

package/lib/api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA8J;AAC9J,4CAAmH;AACnH,yDAA0E;AAC1E,uDAAsE;AACtE,wDAAqE;AACrE,uCAAyB;AAGzB,yCAA0H;AAyG1H;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACU,QAAA,EAAE,GAAqB,WAAI,CAAC,MAAM,CAAmB;IAC9D,UAAU,EAAE,eAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IAEjC,IAAI,EAAE,EAAE;IAER,4CAA4C;IAC5C,QAAQ,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;QAClB,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,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAc,EAAE,EAAE;QAEpE,MAAM,iBAAiB,GAAG,IAAI,4BAAiB,EAAE,CAAC;QAElD,eAAgB,CAAC,SAAS,CAAC;YACvB,UAAU,EAAE,UAAU;YACtB,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,WAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,yBAAyB,EAAE;YAC1C,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,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,EAAE;QAC/B,MAAM,GAAG,CAAC,WAAI,CAAC,gBAAgB,CAAC,uCAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,gBAAgB,EAAE,QAAQ;IAE1B,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;IAED,WAAW,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE;QAEnE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,EAAE,CAAC;QAE1C,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE3D,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;CACJ,CAAC,CAAC;AAEU,QAAA,IAAI,GAAqB,UAAE,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACU,QAAA,QAAQ,GAAiC,UAAE,CAAC,QAAQ,CAAC;AACrD,QAAA,SAAS,GAAkC,UAAE,CAAC,SAAS,CAAC;AACxD,QAAA,UAAU,GAAmC,UAAE,CAAC,UAAU,CAAC;AAC3D,QAAA,SAAS,GAAkC,UAAE,CAAC,SAAS,CAAC;AACxD,QAAA,QAAQ,GAAiC,UAAE,CAAC,QAAQ,CAAC;AACrD,QAAA,MAAM,GAA+B,UAAE,CAAC,MAAM,CAAC"}

package/src/PlaywrightTestConfig.ts

@@ -1,6 +0,0 @@
-import type { PlaywrightTestConfig as BasePlaywrightTestConfig } from '@playwright/test';
-import { ClassDescription } from '@serenity-js/core';
-
-export type PlaywrightTestConfig<BaseConfig extends BasePlaywrightTestConfig = BasePlaywrightTestConfig> = Omit<BaseConfig, 'use' | 'reporter'> & {
-    use?: BaseConfig['use'] & { crew: Array<ClassDescription> }
-};