chore: update APIs for ports (#39796)

Author: dgozman

docs/src/api/class-apiresponseassertions.md

@@ -46,6 +46,24 @@ def test_navigates_to_login_page(page: Page) -> None:
     expect(response).to_be_ok()
 ```
 
+```csharp
+using Microsoft.Playwright;
+using Microsoft.Playwright.MSTest;
+
+namespace PlaywrightTests;
+
+[TestClass]
+public class ExampleTests : PageTest
+{
+    [TestMethod]
+    public async Task NavigatesToLoginPage()
+    {
+        var response = await Page.APIRequest.GetAsync("https://playwright.dev");
+        await Expect(response).ToBeOKAsync();
+    }
+}
+```
+
 ## property: APIResponseAssertions.not
 * since: v1.20
 * langs: java, js, csharp
@@ -65,6 +83,10 @@ await expect(response).not.toBeOK();
 assertThat(response).not().isOK();
 ```
 
+```csharp
+await Expect(response).Not.ToBeOKAsync();
+```
+
 ## async method: APIResponseAssertions.NotToBeOK
 * since: v1.19
 * langs: python
@@ -102,3 +124,7 @@ from playwright.sync_api import expect
 # ...
 expect(response).to_be_ok()
 ```
+
+```csharp
+await Expect(response).ToBeOKAsync();
+```

docs/src/api/class-browsercontext.md

@@ -76,7 +76,6 @@ Playwright has ability to mock clock and passage of time.
 
 ## property: BrowserContext.debugger
 * since: v1.59
-* langs: js
 - type: <[Debugger]>
 
 Debugger allows to pause and resume the execution.
@@ -1004,14 +1003,6 @@ named `page`, but it can be a `Page` or `Frame` type.
 
 Creates a new page in the browser context.
 
-## method: BrowserContext.contextOptions
-* since: v1.59
-* langs: js
-- returns: <[Object]>
-
-Returns the context options that were used to create this browser context. The return type matches the options
-accepted by [`method: Browser.newContext`].
-
 ## method: BrowserContext.pages
 * since: v1.8
 - returns: <[Array]<[Page]>>

docs/src/api/class-cdpsession.md

@@ -69,7 +69,7 @@ client.send("Animation.setPlaybackRate", params);
 
 ## event: CDPSession.close
 * since: v1.59
-* langs: js
+- argument: <[CDPSession]>
 
 Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
 

docs/src/api/class-debugger.md

@@ -1,6 +1,5 @@
 # class: Debugger
 * since: v1.59
-* langs: js
 
 API for controlling the Playwright debugger. The debugger allows pausing script execution and inspecting the page.
 Obtain the debugger instance via [`property: BrowserContext.debugger`].

docs/src/api/class-page.md

@@ -717,7 +717,6 @@ Brings page to front (activates tab).
 
 ## async method: Page.cancelPickLocator
 * since: v1.59
-* langs: js
 
 Cancels an ongoing [`method: Page.pickLocator`] call by deactivating pick locator mode.
 If no pick locator mode is active, this method is a no-op.
@@ -2725,7 +2724,6 @@ Returns up to (currently) 200 last page errors from this page. See [`event: Page
 
 ### option: Page.pageErrors.filter
 * since: v1.59
-* langs: js
 - `filter` <[PageErrorsFilter]<"all"|"sinceNavigation">>
 
 Controls which errors are returned:
@@ -3036,7 +3034,6 @@ Whether or not to embed the document outline into the PDF. Defaults to `false`.
 
 ## async method: Page.pickLocator
 * since: v1.59
-* langs: js
 - returns: <[Locator]>
 
 Enters pick locator mode where hovering over page elements highlights them and shows the corresponding locator.
@@ -3049,6 +3046,26 @@ const locator = await page.pickLocator();
 console.log(locator);
 ```
 
+```java
+Locator locator = page.pickLocator();
+System.out.println(locator);
+```
+
+```python async
+locator = await page.pick_locator()
+print(locator)
+```
+
+```python sync
+locator = page.pick_locator()
+print(locator)
+```
+
+```csharp
+var locator = await page.PickLocatorAsync();
+Console.WriteLine(locator);
+```
+
 ## async method: Page.press
 * since: v1.8
 * discouraged: Use locator-based [`method: Locator.press`] instead. Read more about [locators](../locators.md).

docs/src/api/class-screencast.md

@@ -6,6 +6,7 @@ Interface for capturing screencast frames from a page.
 
 ## async method: Screencast.start
 * since: v1.59
+* langs: js
 - returns: <[Disposable]>
 
 Starts capturing screencast frames.
@@ -30,6 +31,7 @@ Callback that receives JPEG-encoded frame data.
 
 ### option: Screencast.start.preferredSize
 * since: v1.59
+* langs: js
 - `preferredSize` ?<[Object]>
   - `width` <[int]> Max frame width in pixels.
   - `height` <[int]> Max frame height in pixels.
@@ -42,12 +44,14 @@ Defaults to 800×800.
 
 ### option: Screencast.start.annotate
 * since: v1.59
+* langs: js
 - `annotate` ?<[Object]>
   - `delay` ?<[int]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 
 If specified, enables visual annotations on interacted elements during screencast. Interacted elements are highlighted with a semi-transparent blue box and click points are shown as red circles.
 
 ## async method: Screencast.stop
 * since: v1.59
+* langs: js
 
 Stops the screencast started with [`method: Screencast.start`].

packages/playwright-client/types/types.d.ts

@@ -8318,11 +8318,6 @@ export interface BrowserContext {
     behavior?: 'wait'|'ignoreErrors'|'default'
   }): Promise<void>;
 
-  /**
-   * Returns the context options that were used to create this browser context. The return type matches the options
-   * accepted by [browser.newContext([options])](https://playwright.dev/docs/api/class-browser#browser-new-context).
-   */
-  contextOptions(): BrowserContextOptions;
   /**
    * This event is not emitted.
    */
@@ -15830,7 +15825,7 @@ export interface CDPSession {
   /**
    * Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
    */
-  on(event: 'close', listener: () => any): this;
+  on(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing
@@ -15860,7 +15855,7 @@ export interface CDPSession {
   /**
    * Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
    */
-  once(event: 'close', listener: () => any): this;
+  once(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
@@ -15880,7 +15875,7 @@ export interface CDPSession {
   /**
    * Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
    */
-  addListener(event: 'close', listener: () => any): this;
+  addListener(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing
@@ -15910,7 +15905,7 @@ export interface CDPSession {
   /**
    * Removes an event listener added by `on` or `addListener`.
    */
-  removeListener(event: 'close', listener: () => any): this;
+  removeListener(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Removes an event listener added by `on` or `addListener`.
@@ -15930,7 +15925,7 @@ export interface CDPSession {
   /**
    * Removes an event listener added by `on` or `addListener`.
    */
-  off(event: 'close', listener: () => any): this;
+  off(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Removes an event listener added by `on` or `addListener`.
@@ -15950,7 +15945,7 @@ export interface CDPSession {
   /**
    * Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
    */
-  prependListener(event: 'close', listener: () => any): this;
+  prependListener(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing

packages/playwright-core/src/client/browserContext.ts

@@ -38,7 +38,7 @@ import { WebError } from './webError';
 import { Worker } from './worker';
 import { TimeoutSettings } from './timeoutSettings';
 import { mkdirIfNeeded } from './fileUtils';
-import { headersArrayToObject, headersObjectToArray } from '../utils/isomorphic/headers';
+import { headersObjectToArray } from '../utils/isomorphic/headers';
 import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
 import { isRegExp, isString } from '../utils/isomorphic/rtti';
 import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
@@ -290,10 +290,6 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
     return this._browser;
   }
 
-  contextOptions() {
-    return contextParamsToPublicOptions(this._options);
-  }
-
   pages(): Page[] {
     return [...this._pages];
   }
@@ -607,24 +603,6 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
   return contextParams;
 }
 
-function contextParamsToPublicOptions(params: channels.BrowserNewContextParams): api.BrowserContextOptions {
-  const result = {
-    ...params,
-    viewport: params.noDefaultViewport ? null : params.viewport,
-    extraHTTPHeaders: params.extraHTTPHeaders ? headersArrayToObject(params.extraHTTPHeaders, false) : undefined,
-    colorScheme: params.colorScheme === 'no-override' ? null : params.colorScheme,
-    reducedMotion: params.reducedMotion === 'no-override' ? null : params.reducedMotion,
-    forcedColors: params.forcedColors === 'no-override' ? null : params.forcedColors,
-    contrast: params.contrast === 'no-override' ? null : params.contrast,
-    acceptDownloads: params.acceptDownloads === 'accept' ? true : params.acceptDownloads === 'deny' ? false : undefined,
-    storageState: undefined,
-  };
-  delete result.clientCertificates;
-  delete result.noDefaultViewport;
-  delete result.selectorEngines;
-  return result;
-}
-
 function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
   if (acceptDownloads === undefined)
     return undefined;

packages/playwright-core/src/client/cdpSession.ts

@@ -34,7 +34,7 @@ export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> impleme
     });
 
     this._channel.on('close', () => {
-      this.emit('close');
+      this.emit('close', this);
     });
 
     this.on = super.on;

packages/playwright-core/types/types.d.ts

@@ -8318,11 +8318,6 @@ export interface BrowserContext {
     behavior?: 'wait'|'ignoreErrors'|'default'
   }): Promise<void>;
 
-  /**
-   * Returns the context options that were used to create this browser context. The return type matches the options
-   * accepted by [browser.newContext([options])](https://playwright.dev/docs/api/class-browser#browser-new-context).
-   */
-  contextOptions(): BrowserContextOptions;
   /**
    * This event is not emitted.
    */
@@ -15830,7 +15825,7 @@ export interface CDPSession {
   /**
    * Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
    */
-  on(event: 'close', listener: () => any): this;
+  on(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing
@@ -15860,7 +15855,7 @@ export interface CDPSession {
   /**
    * Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
    */
-  once(event: 'close', listener: () => any): this;
+  once(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
@@ -15880,7 +15875,7 @@ export interface CDPSession {
   /**
    * Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
    */
-  addListener(event: 'close', listener: () => any): this;
+  addListener(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing
@@ -15910,7 +15905,7 @@ export interface CDPSession {
   /**
    * Removes an event listener added by `on` or `addListener`.
    */
-  removeListener(event: 'close', listener: () => any): this;
+  removeListener(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Removes an event listener added by `on` or `addListener`.
@@ -15930,7 +15925,7 @@ export interface CDPSession {
   /**
    * Removes an event listener added by `on` or `addListener`.
    */
-  off(event: 'close', listener: () => any): this;
+  off(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Removes an event listener added by `on` or `addListener`.
@@ -15950,7 +15945,7 @@ export interface CDPSession {
   /**
    * Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
    */
-  prependListener(event: 'close', listener: () => any): this;
+  prependListener(event: 'close', listener: (cdpSession: CDPSession) => any): this;
 
   /**
    * Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing