version update

GCuser99 · GCuser99 · commit 7f85cc088d9d · 2025-12-30T06:31:08.000-07:00
Added GetWebSocketUrl property to WebDriver class to facilitate BiDi connections [@hanamichi77777] Added test_bidi sub to test_Capabilities module
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ A comprehensive Selenium wrapper for browser automation developed for MS Office
 
 **What's New?**
 
-- Now [WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) compatible - see [hanamichi77777](https://github.com/hanamichi77777)'s WebDriver BiDi for SeleniumVBA [GitHub repo](https://github.com/hanamichi77777/WebDriverBiDi-via-VBA-test)
+- Now [WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) compatible - see hanamichi77777's [WebDriver BiDi for SeleniumVBA GitHub repo](https://github.com/hanamichi77777/WebDriverBiDi-via-VBA-test)
 - Featured on [Sancarn](https://github.com/sancarn)'s curated [Awesome VBA list](https://github.com/sancarn/awesome-vba?tab=readme-ov-file#web-tools) [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
 
 ## Setup
diff --git a/dist/SeleniumVBA.accdb b/dist/SeleniumVBA.accdb
diff --git a/dist/SeleniumVBA.xlsm b/dist/SeleniumVBA.xlsm
diff --git a/dist/SeleniumVBADLLSetup.exe b/dist/SeleniumVBADLLSetup.exe
diff --git a/dist/SeleniumVBA_prior_to_2508.xlsm b/dist/SeleniumVBA_prior_to_2508.xlsm
diff --git a/dist/SeleniumVBA_with_pw_123.xlsm b/dist/SeleniumVBA_with_pw_123.xlsm
diff --git a/src/VBA/ClassFactory.bas b/src/VBA/ClassFactory.bas
@@ -3,7 +3,7 @@ Attribute VB_Description = "This class is used for object instantiation when ref
 '@ModuleDescription "This class is used for object instantiation when referencing SeleniumVBA externally from another code project"
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebActionChain.cls b/src/VBA/WebActionChain.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to emulate a human interaction se
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebAlert.cls b/src/VBA/WebAlert.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage browser alerts - must b
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebCapabilities.cls b/src/VBA/WebCapabilities.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage/set Selenium optional C
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebCookie.cls b/src/VBA/WebCookie.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage/modify a cookie object"
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebCookies.cls b/src/VBA/WebCookies.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage a collection of cookie
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebDriver.cls b/src/VBA/WebDriver.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class provides the main mechanism to control/au
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
@@ -69,6 +69,8 @@ Private Const baseDomIdx As Integer = 1
 Private sessionId_ As String
 Private driverUrl_ As String
 Private browser_ As svbaBrowser
+'For BiDi compatibility - holds connection string if BiDi mode enabled
+Private webSocketUrl_ As String
 
 'holds defaults for command window style, default io folder, and default driver folder
 Private appWinStyle As VbAppWinStyle
@@ -477,6 +479,11 @@ Attribute OpenBrowser.VB_Description = "Opens browser instance with specified ca
     
     sessionId_ = resp("sessionId")
     
+    'capture websocket connection info if in BiDi mode
+    If resp("capabilities").Exists("webSocketUrl") Then
+        webSocketUrl_ = resp("capabilities")("webSocketUrl")
+    End If
+    
     'set timeouts if different from sys defaults
     If curImplicitWait <> sysImplicitWait Then ImplicitMaxWait = curImplicitWait
     If curScriptTimeout <> sysScriptTimeout Then ScriptTimeout = curScriptTimeout
@@ -490,6 +497,12 @@ Attribute CloseBrowser.VB_Description = "Closes browser without terminating driv
     sessionId_ = vbNullString
 End Sub
 
+'@Description("Access point for BiDi (WebDriver Bi-Directional) features.")
+Public Property Get GetWebSocketUrl() As String
+Attribute GetWebSocketUrl.VB_Description = "Access point for BiDi (WebDriver Bi-Directional) features."
+    GetWebSocketUrl = webSocketUrl_
+End Property
+
 '@Description("Navigates browser to a specified webpage and returns true if no timeout or other error")
 Public Function NavigateTo(ByVal Url As String, Optional ByVal timeOutms As Long = -1, Optional ByVal raiseError As Boolean = True) As Boolean
 Attribute NavigateTo.VB_Description = "Navigates browser to a specified webpage and returns true if no timeout or other error"
diff --git a/src/VBA/WebDriverManager.cls b/src/VBA/WebDriverManager.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to maintain Selenium driver/brows
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebElement.cls b/src/VBA/WebElement.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class provides a mechanism to represent webpage
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebElements.cls b/src/VBA/WebElements.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used for managing a collection of WebE
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebKeyboard.cls b/src/VBA/WebKeyboard.cls
@@ -13,7 +13,7 @@ Attribute VB_Description = "This class is used to automate keyboard actions"
 '@PredeclaredId
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebPrintSettings.cls b/src/VBA/WebPrintSettings.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage print settings for gene
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebShadowRoot.cls b/src/VBA/WebShadowRoot.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used for exposing a shadow root DOM su
 '@ModuleDescription "This class is used for exposing a shadow root DOM subtree that is rendered separately from a document's main DOM tree - must be instantiated using WebDriver's GetShadowRoot method"
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebShared.bas b/src/VBA/WebShared.bas
@@ -1,7 +1,7 @@
 Attribute VB_Name = "WebShared"
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebWindow.cls b/src/VBA/WebWindow.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage the browser window - mu
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/VBA/WebWindows.cls b/src/VBA/WebWindows.cls
@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to manage a collection of WebWind
 '@Exposed
 '@folder("SeleniumVBA.Source")
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/twinBASIC/Build/SeleniumVBA_win32.dll b/src/twinBASIC/Build/SeleniumVBA_win32.dll
diff --git a/src/twinBASIC/Build/SeleniumVBA_win64.dll b/src/twinBASIC/Build/SeleniumVBA_win64.dll
diff --git a/src/twinBASIC/SeleniumVBA.twinproj b/src/twinBASIC/SeleniumVBA.twinproj
diff --git a/src/twinBASIC/Sources/DLLExports.twin b/src/twinBASIC/Sources/DLLExports.twin
@@ -1,6 +1,6 @@
 Public Module DLLExports
 ' ==========================================================================
-' SeleniumVBA v7.1
+' SeleniumVBA v7.2
 '
 ' A Selenium wrapper for browser automation developed for MS Office VBA
 '
diff --git a/src/twinBASIC/Sources/Utils.twin b/src/twinBASIC/Sources/Utils.twin
@@ -1,7 +1,7 @@
 Private Module Utils
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebActionChain.twin b/src/twinBASIC/Sources/WebActionChain.twin
@@ -6,7 +6,7 @@
 Public Class WebActionChain
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebAlert.twin b/src/twinBASIC/Sources/WebAlert.twin
@@ -6,7 +6,7 @@
 Public Class WebAlert
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebCapabilities.twin b/src/twinBASIC/Sources/WebCapabilities.twin
@@ -6,7 +6,7 @@
 Public Class WebCapabilities
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebCookie.twin b/src/twinBASIC/Sources/WebCookie.twin
@@ -7,7 +7,7 @@
 Public Class WebCookie
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebCookies.twin b/src/twinBASIC/Sources/WebCookies.twin
@@ -6,7 +6,7 @@
 Public Class WebCookies
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebDriver.twin b/src/twinBASIC/Sources/WebDriver.twin
@@ -7,7 +7,7 @@
 Public Class WebDriver
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
@@ -64,6 +64,8 @@ Public Class WebDriver
     Private sessionId_ As String
     Private driverUrl_ As String
     Private browser_ As svbaBrowser
+    'For BiDi compatibility - holds connection string if BiDi mode enabled
+    Private webSocketUrl_ As String
 
     'holds defaults for command window style, default io folder, and default driver folder
     Private appWinStyle As VbAppWinStyle
@@ -465,6 +467,11 @@ Public Class WebDriver
         End If
     
         sessionId_ = resp("sessionId")
+        
+        'capture websocket connection info if in BiDi mode
+        If resp("capabilities").Exists("webSocketUrl") Then
+            webSocketUrl_ = resp("capabilities")("webSocketUrl")
+        End If
     
         'set timeouts if different from sys defaults
         If curImplicitWait <> sysImplicitWait Then ImplicitMaxWait = curImplicitWait
@@ -477,6 +484,11 @@ Public Class WebDriver
         execute tCMD.CMD_QUIT
         sessionId_ = vbNullString
     End Sub
+    
+    [Description("Access point for BiDi (WebDriver Bi-Directional) features.")]
+    Public Property Get GetWebSocketUrl() As String
+        GetWebSocketUrl = webSocketUrl_
+    End Property
 
     [Description("Navigates browser to a specified webpage and returns true if no timeout or other error")]
     Public Function NavigateTo(ByVal Url As String, Optional ByVal timeOutms As Long = -1, Optional ByVal raiseError As Boolean = True) As Boolean
diff --git a/src/twinBASIC/Sources/WebDriverManager.twin b/src/twinBASIC/Sources/WebDriverManager.twin
@@ -7,7 +7,7 @@
 Public Class WebDriverManager
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebElement.twin b/src/twinBASIC/Sources/WebElement.twin
@@ -6,7 +6,7 @@
 Public Class WebElement
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebElements.twin b/src/twinBASIC/Sources/WebElements.twin
@@ -6,7 +6,7 @@
 [Description("This class is used for managing a collection of WebElement objects")]
 Public Class WebElements
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebKeyboard.twin b/src/twinBASIC/Sources/WebKeyboard.twin
@@ -6,7 +6,7 @@
 [Description("This class is used to automate keyboard actions")]
 Public Class WebKeyboard
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebPrintSettings.twin b/src/twinBASIC/Sources/WebPrintSettings.twin
@@ -7,7 +7,7 @@
 Public Class WebPrintSettings
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebShadowRoot.twin b/src/twinBASIC/Sources/WebShadowRoot.twin
@@ -6,7 +6,7 @@
 Public Class WebShadowRoot
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebShared.twin b/src/twinBASIC/Sources/WebShared.twin
@@ -1,7 +1,7 @@
 Private Module WebShared
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebWindow.twin b/src/twinBASIC/Sources/WebWindow.twin
@@ -6,7 +6,7 @@
 Public Class WebWindow
 
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/Sources/WebWindows.twin b/src/twinBASIC/Sources/WebWindows.twin
@@ -5,7 +5,7 @@
 [Description("This class is used to manage a collection of WebWindow objects - must be instantiated using WebDriver's Windows method")]
 Public Class WebWindows
     ' ==========================================================================
-    ' SeleniumVBA v7.1
+    ' SeleniumVBA v7.2
     '
     ' A Selenium wrapper for browser automation developed for MS Office VBA
     '
diff --git a/src/twinBASIC/no_registration/SeleniumVBA test subs for tB no reg.xlsm b/src/twinBASIC/no_registration/SeleniumVBA test subs for tB no reg.xlsm
diff --git a/src/twinBASIC/setup/test_documents/SeleniumVBA test subs for tB.accdb b/src/twinBASIC/setup/test_documents/SeleniumVBA test subs for tB.accdb
diff --git a/src/twinBASIC/setup/test_documents/SeleniumVBA test subs for tB.xlsm b/src/twinBASIC/setup/test_documents/SeleniumVBA test subs for tB.xlsm
diff --git a/test/test_Capabilities.bas b/test/test_Capabilities.bas
@@ -447,3 +447,27 @@ Sub test_pageLoadStrategy()
     driver.Shutdown
 End Sub
 
+Sub test_bidi()
+    'tests BiDi compatibility
+    Dim driver As SeleniumVBA.WebDriver
+    Dim caps As SeleniumVBA.WebCapabilities
+
+    Set driver = SeleniumVBA.New_WebDriver
+    
+    driver.StartChrome
+    
+    Set caps = driver.CreateCapabilities()
+    
+    'enable BiDi
+    caps.EnableBiDiMode
+
+    driver.OpenBrowser caps
+    
+    'return the websocket url needed by BiDi for connection
+    Debug.Assert driver.GetWebSocketUrl Like "ws://localhost:*"
+    
+    driver.NavigateTo "https://www.wikipedia.org/"
+    
+    driver.CloseBrowser
+    driver.Shutdown
+End Sub

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ Attribute VB_Description = "This class is used for object instantiation when ref`
`3`	`3`	`'@ModuleDescription "This class is used for object instantiation when referencing SeleniumVBA externally from another code project"`
`4`	`4`	`'@folder("SeleniumVBA.Source")`
`5`	`5`	`' ==========================================================================`
`6`		`-' SeleniumVBA v7.1`
	`6`	`+' SeleniumVBA v7.2`
`7`	`7`	`'`
`8`	`8`	`' A Selenium wrapper for browser automation developed for MS Office VBA`
`9`	`9`	`'`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ Attribute VB_Description = "This class is used to emulate a human interaction se`
`12`	`12`	`'@Exposed`
`13`	`13`	`'@folder("SeleniumVBA.Source")`
`14`	`14`	`' ==========================================================================`
`15`		`-' SeleniumVBA v7.1`
	`15`	`+' SeleniumVBA v7.2`
`16`	`16`	`'`
`17`	`17`	`' A Selenium wrapper for browser automation developed for MS Office VBA`
`18`	`18`	`'`