@serenity-js/web 3.0.0-rc.9 → 3.0.0

package/lib/screenplay/interactions/TakeScreenshot.d.ts

@@ -1,67 +1,45 @@
 import { Answerable, AnswersQuestions, CollectsArtifacts, Interaction, UsesAbilities } from '@serenity-js/core';
 /**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  take a screenshot and emit an {@link @serenity-js/core/lib/model~Artifact},
- *  which can then be persisted by {@link @serenity-js/core/lib/stage/crew/artifact-archiver~ArtifactArchiver}
- *  and reported by [Serenity BDD reporter](/modules/serenity-bdd).
+ * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * to take a screenshot and emit an {@apilink Artifact},
+ * which can then be persisted by {@apilink ArtifactArchiver}
+ * and reported by [Serenity BDD reporter](/api/serenity-bdd).
  *
- * @example <caption>Clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Navigate, TakeScreenshot } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
+ * #### Taking a screenshot
  *
- *  actorCalled('Tania')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Navigate.to('/app'),
- *          TakeScreenshot.of('my app'),
- *      );
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Navigate, TakeScreenshot } from '@serenity-js/protractor';
  *
- * @see {@link BrowseTheWeb}
- * @see {@link @serenity-js/core/lib/screenplay/actor~CollectsArtifacts}
- * @see {@link @serenity-js/core/lib/model~Artifact}
- * @see {@link @serenity-js/core/lib/stage/crew/artifact-archiver~ArtifactArchiver}
+ * await actorCalled('Tania')
+ *   .attemptsTo(
+ *     Navigate.to('/app'),
+ *     TakeScreenshot.of('my app'),
+ *   )
+ * ```
  *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
+ * ## Learn more
+ *
+ * - {@apilink BrowseTheWeb}
+ * - {@apilink CollectsArtifacts}
+ * - {@apilink Artifact}
+ * - {@apilink ArtifactArchiver}
+ *
+ * @group Activities
  */
 export declare class TakeScreenshot extends Interaction {
     private readonly name;
     /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<string>} name
-     *  The name to associate the screenshot with
+     * Instantiates this {@apilink Interaction}.
      *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     * @param name
+     *  The name to give the emitted {@apilink Artifact}
      */
     static of(name: Answerable<string>): Interaction;
+    protected constructor(name: Answerable<string>);
     /**
-     * @param {Answerable<string>} name
-     *  The name to associate the screenshot with
-     */
-    constructor(name: Answerable<string>);
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & AnswersQuestions} actor
-     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @returns {PromiseLike<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
+     * @inheritDoc
      */
     performAs(actor: UsesAbilities & AnswersQuestions & CollectsArtifacts): Promise<void>;
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string;
 }
+//# sourceMappingURL=TakeScreenshot.d.ts.map

package/lib/screenplay/interactions/TakeScreenshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TakeScreenshot.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAK,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAKnH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAYrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAV3C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAIhD,SAAS,aAA8B,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;IAI/D;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAU9F"}

package/lib/screenplay/interactions/TakeScreenshot.js

@@ -2,84 +2,59 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TakeScreenshot = void 0;
 const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
 const model_1 = require("@serenity-js/core/lib/model");
 const abilities_1 = require("../abilities");
 /**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  take a screenshot and emit an {@link @serenity-js/core/lib/model~Artifact},
- *  which can then be persisted by {@link @serenity-js/core/lib/stage/crew/artifact-archiver~ArtifactArchiver}
- *  and reported by [Serenity BDD reporter](/modules/serenity-bdd).
+ * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * to take a screenshot and emit an {@apilink Artifact},
+ * which can then be persisted by {@apilink ArtifactArchiver}
+ * and reported by [Serenity BDD reporter](/api/serenity-bdd).
  *
- * @example <caption>Clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Navigate, TakeScreenshot } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
+ * #### Taking a screenshot
  *
- *  actorCalled('Tania')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Navigate.to('/app'),
- *          TakeScreenshot.of('my app'),
- *      );
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Navigate, TakeScreenshot } from '@serenity-js/protractor';
  *
- * @see {@link BrowseTheWeb}
- * @see {@link @serenity-js/core/lib/screenplay/actor~CollectsArtifacts}
- * @see {@link @serenity-js/core/lib/model~Artifact}
- * @see {@link @serenity-js/core/lib/stage/crew/artifact-archiver~ArtifactArchiver}
+ * await actorCalled('Tania')
+ *   .attemptsTo(
+ *     Navigate.to('/app'),
+ *     TakeScreenshot.of('my app'),
+ *   )
+ * ```
  *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
+ * ## Learn more
+ *
+ * - {@apilink BrowseTheWeb}
+ * - {@apilink CollectsArtifacts}
+ * - {@apilink Artifact}
+ * - {@apilink ArtifactArchiver}
+ *
+ * @group Activities
  */
 class TakeScreenshot extends core_1.Interaction {
     /**
-     * @param {Answerable<string>} name
-     *  The name to associate the screenshot with
-     */
-    constructor(name) {
-        super();
-        this.name = name;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
+     * Instantiates this {@apilink Interaction}.
      *
-     * @param {Answerable<string>} name
-     *  The name to associate the screenshot with
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     * @param name
+     *  The name to give the emitted {@apilink Artifact}
      */
     static of(name) {
         return new TakeScreenshot(name);
     }
+    constructor(name) {
+        super((0, core_1.d) `#actor takes a screenshot of ${name}`);
+        this.name = name;
+    }
     /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & AnswersQuestions} actor
-     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @returns {PromiseLike<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
+     * @inheritDoc
      */
     async performAs(actor) {
-        const screenshot = await abilities_1.BrowseTheWeb.as(actor).takeScreenshot();
+        const page = await abilities_1.BrowseTheWeb.as(actor).currentPage();
+        const screenshot = await page.takeScreenshot();
         const name = await actor.answer(this.name);
         actor.collect(model_1.Photo.fromBase64(screenshot), new model_1.Name(name));
     }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor takes a screenshot of ${this.name}`;
-    }
 }
 exports.TakeScreenshot = TakeScreenshot;
 //# sourceMappingURL=TakeScreenshot.js.map

package/lib/screenplay/interactions/TakeScreenshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"TakeScreenshot.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":";;;AAAA,4CAAgH;AAChH,iDAAqD;AACrD,uDAA0D;AAE1D,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,cAAe,SAAQ,kBAAW;IAe3C;;;OAGG;IACH,YAA6B,IAAwB;QACjD,KAAK,EAAE,CAAC;QADiB,SAAI,GAAJ,IAAI,CAAoB;IAErD,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,IAAwB;QAC9B,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAUD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,UAAU,GAAM,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC;QACpE,MAAM,IAAI,GAAY,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpD,KAAK,CAAC,OAAO,CACT,aAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAC5B,IAAI,YAAI,CAAC,IAAI,CAAC,CACjB,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,gCAAgC,IAAI,CAAC,IAAI,EAAE,CAAC;IACjE,CAAC;CACJ;AAxDD,wCAwDC"}
+{"version":3,"file":"TakeScreenshot.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":";;;AAAA,4CAAmH;AACnH,uDAA0D;AAE1D,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,cAAe,SAAQ,kBAAW;IAE3C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAwB;QAC9B,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,YAAuC,IAAwB;QAC3D,KAAK,CAAC,IAAA,QAAC,EAAA,gCAAiC,IAAK,EAAE,CAAC,CAAC;QADd,SAAI,GAAJ,IAAI,CAAoB;IAE/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,IAAI,GAAY,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QACjE,MAAM,UAAU,GAAM,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,IAAI,GAAY,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpD,KAAK,CAAC,OAAO,CACT,aAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAC5B,IAAI,YAAI,CAAC,IAAI,CAAC,CACjB,CAAC;IACN,CAAC;CACJ;AA7BD,wCA6BC"}

package/lib/screenplay/interactions/index.d.ts

@@ -5,12 +5,11 @@ export * from './Enter';
 export * from './ExecuteScript';
 export * from './Hover';
 export * from './Navigate';
+export * from './PageElementInteraction';
 export * from './Press';
-export * from './PressBuilder';
 export * from './RightClick';
 export * from './Scroll';
 export * from './Select';
-export * from './SelectBuilder';
 export * from './Switch';
 export * from './TakeScreenshot';
-export * from './Wait';
+//# sourceMappingURL=index.d.ts.map

package/lib/screenplay/interactions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC"}

package/lib/screenplay/interactions/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -17,13 +21,11 @@ __exportStar(require("./Enter"), exports);
 __exportStar(require("./ExecuteScript"), exports);
 __exportStar(require("./Hover"), exports);
 __exportStar(require("./Navigate"), exports);
+__exportStar(require("./PageElementInteraction"), exports);
 __exportStar(require("./Press"), exports);
-__exportStar(require("./PressBuilder"), exports);
 __exportStar(require("./RightClick"), exports);
 __exportStar(require("./Scroll"), exports);
 __exportStar(require("./Select"), exports);
-__exportStar(require("./SelectBuilder"), exports);
 __exportStar(require("./Switch"), exports);
 __exportStar(require("./TakeScreenshot"), exports);
-__exportStar(require("./Wait"), exports);
 //# sourceMappingURL=index.js.map

package/lib/screenplay/interactions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,0CAAwB;AACxB,gDAA8B;AAC9B,0CAAwB;AACxB,kDAAgC;AAChC,0CAAwB;AACxB,6CAA2B;AAC3B,0CAAwB;AACxB,iDAA+B;AAC/B,+CAA6B;AAC7B,2CAAyB;AACzB,2CAAyB;AACzB,kDAAgC;AAChC,2CAAyB;AACzB,mDAAiC;AACjC,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,0CAAwB;AACxB,gDAA8B;AAC9B,0CAAwB;AACxB,kDAAgC;AAChC,0CAAwB;AACxB,6CAA2B;AAC3B,2DAAyC;AACzC,0CAAwB;AACxB,+CAA6B;AAC7B,2CAAyB;AACzB,2CAAyB;AACzB,2CAAyB;AACzB,mDAAiC"}

package/lib/screenplay/models/BrowserCapabilities.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Basic meta-data about the browser used in the test
+ *
+ * ## Learn more
+ *
+ * - {@apilink BrowseTheWeb.browserCapabilities}
+ *
+ * @group Models
+ */
+export interface BrowserCapabilities {
+    /**
+     * Name of the operating system platform the test is executed on, like `darwin`, `linux` or `windows`.
+     */
+    platformName?: string;
+    /**
+     * Name of the Web browser the test is executed in, like `chrome`, `firefox` or `safari`.
+     */
+    browserName?: string;
+    /**
+     * Version number of the browser the test is executed in.
+     */
+    browserVersion?: string;
+}
+//# sourceMappingURL=BrowserCapabilities.d.ts.map

package/lib/screenplay/models/BrowserCapabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserCapabilities.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/BrowserCapabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B"}

package/lib/screenplay/models/BrowserCapabilities.js.map

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

package/lib/screenplay/models/BrowsingSession.d.ts

@@ -0,0 +1,69 @@
+import { CorrelationId } from '@serenity-js/core/lib/model';
+import { Page } from './Page';
+/**
+ * Represents the pages open in the current browsing context.
+ *
+ * You'll need to use this class directly only if you're planning to integrate Serenity/JS
+ * with a new Web integration tool.
+ *
+ * @group Models
+ */
+export declare abstract class BrowsingSession<Page_Type extends Page> {
+    protected currentBrowserPage: Page_Type;
+    protected readonly pages: Map<CorrelationId, Page_Type>;
+    closePagesOtherThan(pageOfInterest: Page_Type): Promise<void>;
+    /**
+     * Opens a new browser page and associates it with a {@apilink Page} object.
+     */
+    protected abstract registerCurrentPage(): Promise<Page_Type>;
+    /**
+     * Returns a {@apilink Page} representing the currently active top-level browsing context.
+     */
+    currentPage(): Promise<Page_Type>;
+    /**
+     * Registers specified {@apilink Page|pages} to be managed by this {@apilink BrowsingSession}.
+     *
+     * @param pages
+     */
+    register(...pages: Page_Type[]): void;
+    /**
+     * Informs this {@apilink BrowsingSession} that it should no longer manage {@apilink Page|pages}
+     * identified by the given `pageIds`.
+     *
+     * @param pageIds
+     */
+    deregister(...pageIds: CorrelationId[]): void;
+    /**
+     * Returns a {@apilink Page|pages} representing all the available
+     * top-level browsing context, e.g. all the open browser tabs.
+     */
+    allPages(): Promise<Array<Page_Type>>;
+    /**
+     * Returns the ids of any {@apilink Page|pages} this {@apilink BrowsingSession} is aware of.
+     */
+    registeredPageIds(): Array<CorrelationId>;
+    /**
+     * Informs the {@apilink BrowsingSession} that the "current page" has changed to `page`.
+     *
+     * Please note that different Web integration tools have a different definition of what a "current page" is.
+     * For example, Selenium or WebdriverIO use a single "focused" window that a developer
+     * needs to explicitly "switch to" in their tests in order to interact with it.
+     * This is similar to how a regular user would interact with Web pages;
+     * switching from one tab to another, but not interacting with more than one
+     * window/tab simultaneously.
+     *
+     * Playwright and Puppeteer, on the other hand, don't have a concept of the "current" page at all, since they
+     * allow the developer to interact with multiple open tabs/windows at the same time.
+     *
+     * Web integration-specific implementations of this class should override this method to define
+     * how the concept of the "current page" should be interpreted by Serenity/JS.
+     *
+     * @param page
+     */
+    changeCurrentPageTo(page: Page_Type): Promise<void>;
+    /**
+     * Closes all the pages available in this browsing context
+     */
+    closeAllPages(): Promise<void>;
+}
+//# sourceMappingURL=BrowsingSession.d.ts.map

package/lib/screenplay/models/BrowsingSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowsingSession.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/BrowsingSession.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;;;;;GAOG;AACH,8BAAsB,eAAe,CAAC,SAAS,SAAS,IAAI;IACxD,SAAS,CAAC,kBAAkB,EAAE,SAAS,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAuC;IAExF,mBAAmB,CAAC,cAAc,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAWnE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,IAAI,OAAO,CAAC,SAAS,CAAC;IAE5D;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC;IAQvC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI;IAMrC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,OAAO,EAAE,aAAa,EAAE,GAAG,IAAI;IAM7C;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAI3C;;OAEG;IACH,iBAAiB,IAAI,KAAK,CAAC,aAAa,CAAC;IAIzC;;;;;;;;;;;;;;;;;OAiBG;IACG,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzD;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;CAQvC"}

package/lib/screenplay/models/BrowsingSession.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowsingSession = void 0;
+/**
+ * Represents the pages open in the current browsing context.
+ *
+ * You'll need to use this class directly only if you're planning to integrate Serenity/JS
+ * with a new Web integration tool.
+ *
+ * @group Models
+ */
+class BrowsingSession {
+    constructor() {
+        this.pages = new Map();
+    }
+    async closePagesOtherThan(pageOfInterest) {
+        for (const page of await this.allPages()) {
+            if (!page.id.equals(pageOfInterest.id)) {
+                await page.close();
+                this.pages.delete(page.id);
+            }
+        }
+        await this.changeCurrentPageTo(pageOfInterest);
+    }
+    /**
+     * Returns a {@apilink Page} representing the currently active top-level browsing context.
+     */
+    async currentPage() {
+        if (!this.currentBrowserPage || !await this.currentBrowserPage.isPresent()) {
+            this.currentBrowserPage = await this.registerCurrentPage();
+        }
+        return this.currentBrowserPage;
+    }
+    /**
+     * Registers specified {@apilink Page|pages} to be managed by this {@apilink BrowsingSession}.
+     *
+     * @param pages
+     */
+    register(...pages) {
+        for (const page of pages) {
+            this.pages.set(page.id, page);
+        }
+    }
+    /**
+     * Informs this {@apilink BrowsingSession} that it should no longer manage {@apilink Page|pages}
+     * identified by the given `pageIds`.
+     *
+     * @param pageIds
+     */
+    deregister(...pageIds) {
+        for (const pageId of pageIds) {
+            this.pages.delete(pageId);
+        }
+    }
+    /**
+     * Returns a {@apilink Page|pages} representing all the available
+     * top-level browsing context, e.g. all the open browser tabs.
+     */
+    async allPages() {
+        return Array.from(this.pages.values());
+    }
+    /**
+     * Returns the ids of any {@apilink Page|pages} this {@apilink BrowsingSession} is aware of.
+     */
+    registeredPageIds() {
+        return Array.from(this.pages.keys());
+    }
+    /**
+     * Informs the {@apilink BrowsingSession} that the "current page" has changed to `page`.
+     *
+     * Please note that different Web integration tools have a different definition of what a "current page" is.
+     * For example, Selenium or WebdriverIO use a single "focused" window that a developer
+     * needs to explicitly "switch to" in their tests in order to interact with it.
+     * This is similar to how a regular user would interact with Web pages;
+     * switching from one tab to another, but not interacting with more than one
+     * window/tab simultaneously.
+     *
+     * Playwright and Puppeteer, on the other hand, don't have a concept of the "current" page at all, since they
+     * allow the developer to interact with multiple open tabs/windows at the same time.
+     *
+     * Web integration-specific implementations of this class should override this method to define
+     * how the concept of the "current page" should be interpreted by Serenity/JS.
+     *
+     * @param page
+     */
+    async changeCurrentPageTo(page) {
+        this.currentBrowserPage = page;
+    }
+    /**
+     * Closes all the pages available in this browsing context
+     */
+    async closeAllPages() {
+        for (const page of this.pages.values()) {
+            await page.close();
+        }
+        this.pages.clear();
+        this.currentBrowserPage = undefined;
+    }
+}
+exports.BrowsingSession = BrowsingSession;
+//# sourceMappingURL=BrowsingSession.js.map

package/lib/screenplay/models/BrowsingSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowsingSession.js","sourceRoot":"","sources":["../../../src/screenplay/models/BrowsingSession.ts"],"names":[],"mappings":";;;AAIA;;;;;;;GAOG;AACH,MAAsB,eAAe;IAArC;QAEuB,UAAK,GAAkC,IAAI,GAAG,EAA4B,CAAC;IAoGlG,CAAC;IAlGG,KAAK,CAAC,mBAAmB,CAAC,cAAyB;QAC/C,KAAK,MAAM,IAAI,IAAI,MAAM,IAAI,CAAC,QAAQ,EAAE,EAAE;YACtC,IAAI,CAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE;gBACrC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBACnB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAC9B;SACJ;QAED,MAAM,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAOD;;OAEG;IACH,KAAK,CAAC,WAAW;QACb,IAAI,CAAE,IAAI,CAAC,kBAAkB,IAAI,CAAE,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,EAAE;YAC1E,IAAI,CAAC,kBAAkB,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;SAC9D;QAED,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,GAAG,KAAkB;QAC1B,KAAI,MAAM,IAAI,IAAI,KAAK,EAAE;YACrB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACjC;IACL,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,GAAG,OAAwB;QAClC,KAAI,MAAM,MAAM,IAAI,OAAO,EAAE;YACzB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC7B;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACV,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAgB,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,iBAAiB;QACb,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,mBAAmB,CAAC,IAAe;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACf,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE;YACpC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;SACtB;QAED,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;IACxC,CAAC;CACJ;AAtGD,0CAsGC"}