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

package/src/api/test-api.ts

@@ -0,0 +1,252 @@
+import { test as base, TestInfo } from '@playwright/test';
+import { 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';
+import { BrowseTheWebWithPlaywright, PlaywrightPage } from '@serenity-js/playwright';
+import { Photographer, TakePhotosOfFailures } from '@serenity-js/web';
+import * as os from 'os';
+import { ensure, isFunction, JSONValue, property } from 'tiny-types';
+
+import { DomainEventBuffer, PlaywrightStepReporter, SERENITY_JS_DOMAIN_EVENTS_ATTACHMENT_CONTENT_TYPE } from '../reporter';
+import { SerenityFixtures } from './SerenityFixtures';
+import { SerenityOptions } from './SerenityOptions';
+import { SerenityTestType } from './SerenityTestType';
+
+/**
+ * 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
+ * - {@apilink describe|Grouping test scenarios}
+ * - {@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 const it: SerenityTestType = base.extend<Omit<SerenityOptions, 'actors'> & SerenityFixtures>({
+
+    actors: [
+        ({ browser, contextOptions }, use) =>
+            use(Cast.whereEveryoneCan(
+                BrowseTheWebWithPlaywright.using(browser, contextOptions),
+                TakeNotes.usingAnEmptyNotepad(),
+            )),
+        { option: true },
+    ],
+
+    defaultActorName: [
+        'Serena',
+        { option: true },
+    ],
+
+    cueTimeout: [
+        Duration.ofSeconds(5),
+        { option: true },
+    ],
+
+    crew: [
+        [
+            Photographer.whoWill(TakePhotosOfFailures)
+        ],
+        { option: true },
+    ],
+
+    // eslint-disable-next-line no-empty-pattern
+    platform: ({}, use) => {
+        const platform = os.platform();
+
+        // https://nodejs.org/api/process.html#process_process_platform
+        const name = platform === 'win32'
+            ? 'Windows'
+            : (platform === 'darwin' ? 'macOS' : 'Linux');
+
+        use({ name, version: os.release() });
+    },
+
+    serenity: async ({ crew, cueTimeout, platform }, use, info: TestInfo) => {
+
+        const domainEventBuffer = new DomainEventBuffer();
+
+        serenityInstance.configure({
+            cueTimeout: asDuration(cueTimeout),
+            crew: [
+                ...crew,
+                domainEventBuffer,
+                new PlaywrightStepReporter(info),
+            ],
+        });
+
+        serenityInstance.announce(new SceneTagged(
+            serenityInstance.currentSceneId(),
+            new PlatformTag(platform.name, platform.version),
+            serenityInstance.currentTime(),
+        ));
+
+        await use(serenityInstance);
+
+        const serialisedEvents: Array<{ type: string, value: JSONValue }> = [];
+
+        for (const event of domainEventBuffer.flush()) {
+            serialisedEvents.push({
+                type: event.constructor.name,
+                value: event.toJSON(),
+            });
+
+            if (event instanceof SceneTagged) {
+                test.info().annotations.push({ type: event.tag.type, description: event.tag.name });
+            }
+        }
+
+        base.info().attach('serenity-js-events.json', {
+            contentType: SERENITY_JS_DOMAIN_EVENTS_ATTACHMENT_CONTENT_TYPE,
+            body: Buffer.from(JSON.stringify(serialisedEvents), 'utf8'),
+        });
+    },
+
+    actorCalled: async ({ serenity, actors, browser, browserName, contextOptions }, use) => {
+
+        const sceneId = serenity.currentSceneId();
+
+        serenity.engage(asCast(actors));
+
+        const actorCalled = serenity.theActorCalled.bind(serenity);
+
+        serenity.announce(new SceneTagged(
+            sceneId,
+            new BrowserTag(browserName, browser.version()),
+            serenity.currentTime(),
+        ));
+
+        await use(actorCalled);
+
+        serenity.announce(
+            new SceneFinishes(sceneId, serenity.currentTime()),
+        );
+
+        await serenityInstance.waitForNextCue();
+    },
+
+    actor: async ({ actorCalled, defaultActorName }, use) => {
+        await use(actorCalled(defaultActorName));
+    },
+
+    page: async ({ actor }, use) => {
+        const page = (await BrowseTheWebWithPlaywright.as(actor).currentPage()) as PlaywrightPage;
+        const nativePage = await page.nativePage();
+
+        await use(nativePage);
+    },
+});
+
+function asDuration(maybeDuration: number | Duration): Duration {
+    return maybeDuration instanceof Duration
+        ? maybeDuration
+        : Duration.ofMilliseconds(maybeDuration);
+}
+
+function asCast(maybeCast: unknown): Cast {
+    return ensure('actors', maybeCast as Cast, property('prepare', isFunction()));
+}
+
+export const test: SerenityTestType = it;
+
+/**
+ * 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 Serenity/JS {@apilink it|test scenario}
+ * - [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: SerenityTestType['describe'] = it.describe;
+export const beforeAll: SerenityTestType['beforeAll'] = it.beforeAll;
+export const beforeEach: SerenityTestType['beforeEach'] = it.beforeEach;
+export const afterEach: SerenityTestType['afterEach'] = it.afterEach;
+export const afterAll: SerenityTestType['afterAll'] = it.afterAll;
+export const expect: SerenityTestType['expect'] = it.expect;

package/src/index.ts

@@ -1,3 +1,2 @@
 export *  from './api';
-export *  from './PlaywrightTestConfig';
-export { SerenityReporterForPlaywrightTest as default } from './reporter';
+export { SerenityReporterForPlaywrightTest as default, SerenityReporterForPlaywrightTestConfig } from './reporter';

package/src/reporter/PlaywrightStepReporter.ts

@@ -1,7 +1,24 @@
 import { TestError, TestInfo } from '@playwright/test';
 import { Stage, StageCrewMember } from '@serenity-js/core';
-import { DomainEvent, InteractionFinished, InteractionStarts, TaskFinished, TaskStarts } from '@serenity-js/core/lib/events';
-import { ActivityDetails, ProblemIndication } from '@serenity-js/core/lib/model';
+import {
+    ActivityFinished,
+    ActivityRelatedArtifactGenerated,
+    AsyncOperationAborted,
+    AsyncOperationAttempted,
+    AsyncOperationCompleted,
+    AsyncOperationFailed,
+    DomainEvent,
+    InteractionStarts,
+    SceneTagged,
+    TaskStarts,
+} from '@serenity-js/core/lib/events';
+import { FileSystemLocation, Path } from '@serenity-js/core/lib/io';
+import { ActivityDetails, CorrelationId, Description, Name, Photo, ProblemIndication } from '@serenity-js/core/lib/model';
+import { BrowserTag, PlatformTag } from '@serenity-js/core/src/model';
+import { Photographer } from '@serenity-js/web';
+import { match } from 'tiny-types';
+
+const genericPathToPhotographer = Path.from(require.resolve('@serenity-js/web'))
 
 // https://github.com/microsoft/playwright/blob/04f77f231981780704a3a5e2cea93e3c420809a0/packages/playwright-test/types/testReporter.d.ts#L524
 interface Location {
@@ -9,12 +26,12 @@ interface Location {
      * Path to the source file.
      */
     file: string;
-  
+
     /**
      * Line number in the source file.
      */
     line: number;
-  
+
     /**
      * Column number in the source file.
      */
@@ -24,6 +41,7 @@ interface Location {
 // https://github.com/microsoft/playwright/blob/04f77f231981780704a3a5e2cea93e3c420809a0/packages/playwright-test/src/types.ts#L30
 interface TestStepInternal {
     complete(result: { error?: Error | TestError }): void;
+
     title: string;
     category: string;
     canHaveChildren: boolean;
@@ -50,25 +68,80 @@ export class PlaywrightStepReporter implements StageCrewMember {
 
     notifyOf(event: DomainEvent): void {
 
-        if (event instanceof TaskStarts) {
-            this.steps.set(event.activityId.value, this.createStep(event.details, 'task'));
-        }
-
-        if (event instanceof InteractionStarts) {
-            this.steps.set(event.activityId.value, this.createStep(event.details, 'interaction'));
-        }
-
-        if (event instanceof InteractionFinished || event instanceof TaskFinished) {
-            if (event.outcome instanceof ProblemIndication) {
-                this.steps.get(event.activityId.value).complete({ error: event.outcome.error })
-            }
-            else {
-                this.steps.get(event.activityId.value).complete({})
-            }
-        }
+        match<DomainEvent, void>(event)
+            .when(TaskStarts, (e: TaskStarts) => {
+                this.steps.set(e.activityId.value, this.createStep(e.details, 'task'))
+            })
+            .when(InteractionStarts, (e: InteractionStarts) => {
+                this.steps.set(e.activityId.value, this.createStep(e.details, 'interaction'));
+            })
+            .when(AsyncOperationAttempted, (e: AsyncOperationAttempted) => {
+                if (this.isAPhotoAttempt(e)) {
+                    this.steps.set(e.correlationId.value, this.createStep(new ActivityDetails(
+                        new Name(`${ Photographer.name }: ${ e.description.value }`),
+                        new FileSystemLocation(genericPathToPhotographer)
+                    ), 'crew'));
+                }
+            })
+            .when(ActivityFinished, (e: ActivityFinished) => {
+                const error = e.outcome instanceof ProblemIndication
+                    ? e.outcome.error
+                    : undefined;
+
+                this.steps.get(e.activityId.value).complete({ error });
+            })
+            .when(ActivityRelatedArtifactGenerated, (e: ActivityRelatedArtifactGenerated) => {
+                if (e.artifact instanceof Photo) {
+                    this.attachPhotoFrom(e);
+                }
+            })
+            .when(SceneTagged, (e: SceneTagged) => {
+                // don't include platform and browser tags as Playwright already includes them
+                if (! (e.tag instanceof PlatformTag || e.tag instanceof BrowserTag)) {
+                    this.testInfo.annotations.push({ type: e.tag.type, description: e.tag.name });
+                }
+            })
+            .else(e => {
+                if (this.indicatesCompletionOfAnAsyncOperation(e) && this.steps.has(e.correlationId.value)) {
+                    const error = event instanceof AsyncOperationFailed
+                        ? event.error
+                        : undefined;
+
+                    this.steps.get(e.correlationId.value).complete({ error })
+                }
+            })
+    }
+
+    private isAPhotoAttempt(event: AsyncOperationAttempted): event is AsyncOperationAttempted {
+        return event.name.value.startsWith(Photographer.name);
+    }
+
+    private indicatesCompletionOfAnAsyncOperation(event: DomainEvent): event is AsyncOperationCompleted | AsyncOperationAborted | AsyncOperationFailed {
+        return event instanceof AsyncOperationCompleted
+            || event instanceof AsyncOperationAborted
+            || event instanceof AsyncOperationFailed
+    }
+
+    private attachPhotoFrom(event: ActivityRelatedArtifactGenerated) {
+        const id = CorrelationId.create();
+
+        this.stage.announce(new AsyncOperationAttempted(
+            new Name(this.constructor.name),
+            new Description(`Attaching screenshot of '${ event.name.value }'...`),
+            id,
+            this.stage.currentTime(),
+        ));
+
+        this.testInfo.attach(event.name.value, { body: Buffer.from(event.artifact.base64EncodedValue, 'base64'), contentType: 'image/png' })
+            .then(() => {
+                this.stage.announce(new AsyncOperationCompleted(
+                    id,
+                    this.stage.currentTime()
+                ));
+            });
     }
 
-    private createStep(activityDetails: ActivityDetails, type: 'task' | 'interaction'): TestStepInternal {
+    private createStep(activityDetails: ActivityDetails, type: 'task' | 'interaction' | 'crew'): TestStepInternal {
         // https://github.com/microsoft/playwright/blob/04f77f231981780704a3a5e2cea93e3c420809a0/packages/playwright-test/src/expect.ts#L200-L206
         return (this.testInfo as any)._addStep({
             location: activityDetails.location
@@ -77,7 +150,7 @@ export class PlaywrightStepReporter implements StageCrewMember {
             category: `serenity-js:${ type }`,
             title: activityDetails.name.value,
             canHaveChildren: true,
-            forceNoParent: false
+            forceNoParent: false,
         }) as TestStepInternal;
     }
 }

package/src/reporter/SerenityReporterForPlaywrightTest.ts

@@ -1,6 +1,6 @@
-import { FullConfig, TestError } from '@playwright/test';
-import { Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
-import { LogicError, Serenity, serenity as reporterSerenityInstance, StageCrewMember, StageCrewMemberBuilder, Timestamp } from '@serenity-js/core';
+import type { FullConfig, TestError } from '@playwright/test';
+import type { Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
+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,25 +0,0 @@
-import { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from '@playwright/test';
-import { Actor, Cast, Duration, Serenity, SerenityConfig, StageCrewMember } from '@serenity-js/core';
-export interface SerenityFixtures extends SerenityConfig {
-    actors: Cast;
-    crew: StageCrewMember[];
-    cueTimeout: Duration;
-    serenity: Serenity;
-    platform: {
-        name: string;
-        version: string;
-    };
-    actorCalled: (name: string) => Actor;
-    defaultActorName: string;
-    actor: Actor;
-}
-export type SerenityTestType = TestType<PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
-export declare const it: SerenityTestType;
-export declare const test: SerenityTestType;
-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,cAAc,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASnI,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,MAAM,EAAE,IAAI,CAAC;IACb,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAC;IACrC,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CAChB;AAED,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,kBAAkB,GAAG,qBAAqB,GAAG,gBAAgB,EAAE,oBAAoB,GAAG,uBAAuB,CAAC,CAAC;AAEvJ,eAAO,MAAM,EAAE,EAAE,gBAyFf,CAAC;AAEH,eAAO,MAAM,IAAI,EAAE,gBAAqB,CAAC;AACzC,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

@@ -1,97 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expect = exports.afterAll = exports.afterEach = exports.beforeEach = exports.beforeAll = exports.describe = exports.test = exports.it = void 0;
-const test_1 = require("@playwright/test");
-const core_1 = require("@serenity-js/core");
-const events_1 = require("@serenity-js/core/lib/events");
-const model_1 = require("@serenity-js/core/lib/model");
-const playwright_1 = require("@serenity-js/playwright");
-const os = __importStar(require("os"));
-const reporter_1 = require("./reporter");
-exports.it = test_1.test.extend({
-    cueTimeout: core_1.Duration.ofSeconds(5),
-    crew: [],
-    // eslint-disable-next-line no-empty-pattern
-    platform: ({}, use) => {
-        const platform = os.platform();
-        // https://nodejs.org/api/process.html#process_process_platform
-        const name = platform === 'win32'
-            ? 'Windows'
-            : (platform === 'darwin' ? 'macOS' : 'Linux');
-        use({ name, version: os.release() });
-    },
-    serenity: async ({ crew, cueTimeout, platform }, use, info) => {
-        const domainEventBuffer = new reporter_1.DomainEventBuffer();
-        core_1.serenity.configure({
-            cueTimeout: cueTimeout,
-            crew: [
-                ...crew,
-                domainEventBuffer,
-                new reporter_1.PlaywrightStepReporter(info),
-            ],
-        });
-        core_1.serenity.announce(new events_1.SceneTagged(core_1.serenity.currentSceneId(), new model_1.PlatformTag(platform.name, platform.version), core_1.serenity.currentTime()));
-        await use(core_1.serenity);
-        const serialisedEvents = [];
-        for (const event of domainEventBuffer.flush()) {
-            serialisedEvents.push({
-                type: event.constructor.name,
-                value: event.toJSON(),
-            });
-            if (event instanceof events_1.SceneTagged) {
-                exports.test.info().annotations.push({ type: event.tag.type, description: event.tag.name });
-            }
-        }
-        test_1.test.info().attach('serenity-js-events.json', {
-            contentType: reporter_1.SERENITY_JS_DOMAIN_EVENTS_ATTACHMENT_CONTENT_TYPE,
-            body: Buffer.from(JSON.stringify(serialisedEvents), 'utf8'),
-        });
-    },
-    actors: async ({ browser }, use) => {
-        await use(core_1.Cast.whereEveryoneCan(playwright_1.BrowseTheWebWithPlaywright.using(browser)));
-    },
-    defaultActorName: 'Serena',
-    actor: async ({ actorCalled, defaultActorName }, use) => {
-        await use(actorCalled(defaultActorName));
-    },
-    actorCalled: async ({ serenity, actors, browser, browserName }, use) => {
-        serenity.engage(actors);
-        const sceneId = serenity.currentSceneId();
-        const actorCalled = serenity.theActorCalled.bind(serenity);
-        serenity.announce(new events_1.SceneTagged(sceneId, new model_1.BrowserTag(browserName, browser.version()), serenity.currentTime()));
-        await use(actorCalled);
-        serenity.announce(new events_1.SceneFinishes(sceneId, serenity.currentTime()));
-        await core_1.serenity.waitForNextCue();
-    },
-});
-exports.test = exports.it;
-exports.describe = exports.it.describe;
-exports.beforeAll = exports.it.beforeAll;
-exports.beforeEach = exports.it.beforeEach;
-exports.afterEach = exports.it.afterEach;
-exports.afterAll = exports.it.afterAll;
-exports.expect = exports.it.expect;
-//# sourceMappingURL=api.js.map

package/lib/api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA8J;AAC9J,4CAAmI;AACnI,yDAA0E;AAC1E,uDAAsE;AACtE,wDAAqE;AACrE,uCAAyB;AAGzB,yCAA0H;AAe7G,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;AAC5B,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> }
-};