🤖 Merge PR DefinitelyTyped#73713 fix(selenium-webdriver): add jsdoc, export things properly by @hkleungai

Author: hkleungai

types/selenium-webdriver/bidi/scriptTypes.d.ts

@@ -1,37 +1,71 @@
 import { RemoteValue } from "./remoteValue";
 
-interface Source {
+export interface ScriptSource {
     realm: string;
     context?: string;
 }
 
+/**
+ * Represents a message received through a channel.
+ * Described in https://w3c.github.io/webdriver-bidi/#event-script-message.
+ */
 declare class Message {
     private _channel: string;
     private _data: RemoteValue;
     private _source: Source;
 
+    /**
+     * Creates a new Message instance.
+     * @param channel - The channel through which the message is received.
+     * @param data - The data contained in the message.
+     * @param source - The source of the message.
+     */
     constructor(
         channel: string,
         data: RemoteValue,
         source: Source,
     );
 
+    /**
+     * Gets the channel through which the message is received.
+     * @returns The channel.
+     */
     get channel(): string;
 
+    /**
+     * Gets the data contained in the message.
+     * @returns The data.
+     */
     get data(): RemoteValue;
 
+    /**
+     * Gets the source of the message.
+     * @returns The source.
+     */
     get source(): Source;
 }
 
-declare class source {
+/**
+ * Represents a source object.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-script-Source.
+ */
+declare class Source {
     private _browsingContextId: string | null;
     private _realmId: string;
 
-    constructor(
-        source: Source,
-    );
+    constructor(source: ScriptSource);
 
+    /**
+     * Get the browsing context ID.
+     * @returns The browsing context ID.
+     */
     get browsingContextId(): string | null;
 
+    /**
+     * Get the realm ID.
+     * @returns The realm ID.
+     */
     get realmId(): string;
 }
+
+export { Message, Source };

types/selenium-webdriver/test/bidi/scriptTypes.ts

@@ -1,58 +1,39 @@
 import { RemoteValue } from "selenium-webdriver/bidi/remoteValue";
-import { Message, Source, source as SourceClass } from "selenium-webdriver/bidi/scriptTypes";
+import { Message, ScriptSource, Source } from "selenium-webdriver/bidi/scriptTypes";
 
 function testMessageClass() {
-    const source: Source = {
+    const scriptSource: ScriptSource = {
         realm: "testRealm",
         context: "testContext",
     };
 
+    const source = new Source(scriptSource);
+
     const remoteValue: RemoteValue = {
         type: "string",
         value: "testValue",
     };
 
     const message = new Message("testChannel", remoteValue, source);
 
-    if (message.channel !== "testChannel") {
-        console.error("Failed: Message channel does not match expected value");
-    } else {
-        console.log("Passed: Message channel matches expected value");
-    }
-
-    if (message.data !== remoteValue) {
-        console.error("Failed: Message data does not match expected value");
-    } else {
-        console.log("Passed: Message data matches expected value");
-    }
-
-    if (message.source !== source) {
-        console.error("Failed: Message source does not match expected value");
-    } else {
-        console.log("Passed: Message source matches expected value");
-    }
+    // $ExpectType string
+    message.channel;
+    // $ExpectType RemoteValue
+    message.data;
+    // $ExpectType Source
+    message.source;
 }
 
 function testSourceClass() {
-    const sourceInstance: Source = {
+    const scriptSource: ScriptSource = {
         realm: "testRealm",
         context: "testContext",
     };
 
-    const sourceObj = new SourceClass(sourceInstance);
-
-    if (sourceObj.browsingContextId !== null) {
-        console.error("Failed: browsingContextId should be null");
-    } else {
-        console.log("Passed: browsingContextId is null as expected");
-    }
+    const source = new Source(scriptSource);
 
-    if (sourceObj.realmId !== "testRealm") {
-        console.error("Failed: realmId does not match expected value");
-    } else {
-        console.log("Passed: realmId matches expected value");
-    }
+    // $ExpectType string | null
+    source.browsingContextId;
+    // $ExpectType string
+    source.realmId;
 }
-
-testSourceClass();
-testMessageClass();