Skip to content

Conversation

@selenium-ci
Copy link
Member

@selenium-ci selenium-ci commented Mar 22, 2025

User description

This PR updates the API documentation for node language bindings to version 4.30.0.


PR Type

Documentation, Enhancement


Description

  • Updated the API documentation for Selenium JavaScript bindings to version 4.30.0.

  • Added a new HTML file for the ClientWindowInfo class documentation, including detailed parameters and properties.

  • Introduced BiDi protocol permission management with a Permission class and utility functions.

  • Defined a WindowState object and ClientWindowInfo class for encapsulating window information, including a static method fromJson.

  • Includes metadata, navigation, and styling for the new documentation pages.


Changes walkthrough 📝

Relevant files
Documentation
2 files
ClientWindowInfo.html
Add documentation for `ClientWindowInfo` class in JavaScript API.

docs/api/javascript/ClientWindowInfo.html

  • Added a new HTML file for the ClientWindowInfo class documentation.
  • Includes detailed parameters and properties for ClientWindowInfo.
  • Provides metadata, navigation, and styling for the documentation page.
  • +3/-0     
    bidi_clientWindowInfo.js.html
    Add `ClientWindowInfo` class and `WindowState` definitions.

    docs/api/javascript/bidi_clientWindowInfo.js.html

  • Added a new JavaScript file for bidi_clientWindowInfo.js.
  • Defined a WindowState object with various window states.
  • Introduced a ClientWindowInfo class to encapsulate window information.
  • Included a static method fromJson for creating instances from JSON.
  • +57/-0   
    Enhancement
    1 files
    bidi_external_permissions.js.html
    Add BiDi protocol permission management for JavaScript.   

    docs/api/javascript/bidi_external_permissions.js.html

  • Added a new JavaScript file for managing BiDi protocol permissions.
  • Introduced a Permission class to handle permission states and
    interactions.
  • Defined a PermissionState object to standardize permission states.
  • Provided a utility function getPermissionInstance for initializing the
    Permission class.
  • +76/-0   
    Additional files
    101 files
    Action.html +1/-1     
    Actions.html +2/-2     
    Alert.html +1/-1     
    AlertPromise.html +2/-2     
    ArgumentValue.html +1/-1     
    BaseLogEntry.html +1/-1     
    BaseParameters.html +1/-1     
    BeforeRequestSent.html +1/-1     
    BoxClipRectangle.html +1/-1     
    BrowsingContext.html +1/-1     
    BrowsingContextInfo.html +1/-1     
    BrowsingContextInspector.html +1/-1     
    BrowsingContextPartitionDescriptor.html +1/-1     
    Build.html +1/-1     
    Builder.html +2/-2     
    By.html +1/-1     
    BytesValue.html +1/-1     
    Capabilities.html +1/-1     
    CaptureScreenshotParameters.html +1/-1     
    ChannelValue.html +1/-1     
    Client.html +1/-1     
    ClipRectangle.html +1/-1     
    Command.html +1/-1     
    Condition.html +1/-1     
    ConsoleLogEntry.html +1/-1     
    ContinueRequestParameters.html +1/-1     
    ContinueResponseParameters.html +1/-1     
    Cookie.html +1/-1     
    CookieFilter.html +1/-1     
    CreateContextParameters.html +1/-1     
    Credential.html +1/-1     
    DetachedShadowRootError.html +1/-1     
    Device.html +1/-1     
    DriverService.Builder.html +1/-1     
    DriverService.html +1/-1     
    ElementClickInterceptedError.html +1/-1     
    ElementClipRectangle.html +1/-1     
    ElementNotInteractableError.html +1/-1     
    ElementNotSelectableError.html +1/-1     
    Entry.html +1/-1     
    Environment.html +1/-1     
    EvaluateResultException.html +1/-1     
    EvaluateResultSuccess.html +1/-1     
    ExceptionDetails.html +1/-1     
    Executor.html +1/-1     
    FetchError.html +1/-1     
    FetchTimingInfo.html +1/-1     
    FileDetector.html +1/-1     
    GenericLogEntry.html +1/-1     
    Header.html +1/-1     
    HttpClient.html +1/-1     
    HttpResponse.html +1/-1     
    ISelect.html +1/-1     
    IWebDriver.html +2/-2     
    Index_.html +1/-1     
    Initiator.html +1/-1     
    Input.html +1/-1     
    InsecureCertificateError.html +1/-1     
    InvalidArgumentError.html +1/-1     
    InvalidCharacterError.html +1/-1     
    InvalidCookieDomainError.html +1/-1     
    InvalidCoordinatesError.html +1/-1     
    InvalidElementStateError.html +1/-1     
    InvalidSelectorError.html +1/-1     
    JavascriptError.html +1/-1     
    JavascriptLogEntry.html +1/-1     
    Keyboard.html +1/-1     
    Level.html +1/-1     
    LocalValue.html +1/-1     
    Locator.html +1/-1     
    LogManager.html +1/-1     
    Logger.html +1/-1     
    Message.html +1/-1     
    MoveTargetOutOfBoundsError.html +1/-1     
    NavigateResult.html +1/-1     
    NavigationInfo.html +1/-1     
    Network.html +1/-1     
    NetworkInspector.html +1/-1     
    NoSuchAlertError.html +1/-1     
    NoSuchCookieError.html +1/-1     
    NoSuchElementError.html +1/-1     
    NoSuchFrameError.html +1/-1     
    NoSuchSessionError.html +1/-1     
    NoSuchShadowRootError.html +1/-1     
    NoSuchWindowError.html +1/-1     
    Options.Cookie.html +1/-1     
    Options.html +2/-2     
    PartialCookie.html +1/-1     
    PartitionDescriptor.html +1/-1     
    PartitionKey.html +1/-1     
    Pointer.html +1/-1     
    Preferences.html +1/-1     
    PrintResult.html +1/-1     
    ProvideResponseParameters.html +1/-1     
    RealmInfo.html +1/-1     
    ReferenceValue.html +1/-1     
    RegExpValue.html +1/-1     
    RelativeBy.html +1/-1     
    RemoteValue.html +1/-1     
    Request.html +1/-1     
    Additional files not shown

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • @qodo-merge-pro
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Error Handling

    The setPermission method should validate the permissionDescriptor parameter before using it. Currently there's no validation to ensure it contains required properties or is properly formatted.

    async setPermission(permissionDescriptor, state, origin, userContext = null) {
      if (!Object.values(PermissionState).includes(state)) {
        throw new Error(`Invalid permission state. Must be one of: ${Object.values(PermissionState).join(', ')}`)
      }

    @qodo-merge-pro
    Copy link
    Contributor

    qodo-merge-pro bot commented Mar 22, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @titusfortner titusfortner requested a review from harsha509 March 22, 2025 00:36
    @harsha509 harsha509 merged commit bdaf184 into gh-pages Mar 26, 2025
    1 check passed
    @harsha509 harsha509 deleted the api-docs-4.30.0-node branch March 26, 2025 09:15
    @titusfortner titusfortner added B-docs API Docs; see other repo for website documentation and removed documentation labels Mar 30, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    B-docs API Docs; see other repo for website documentation Review effort 1/5

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants