appium/packages/base-driver/CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

9.11.3 (2024-08-07)

Bug Fixes

• base-driver: calls startNewCommandTimeout before returning NotYetImplementedError (#20380) (6a97fe4)
• base-driver: change required to option for setWindowRect to follow w3c (#20391) (9eb65f7)
• base-driver: Start command timeout even if the recent command has thrown an exception (#20379) (139dbae)
• base-driver: update dependency path-to-regexp to v7.1.0 (#20376) (6488a0a)
• driver-test-support: update dependency @types/lodash to v4.17.7 (#20382) (d5ef0f9)
• logger: update dependency lru-cache to v10.4.3 (#20364) (8d79467)
• support: update dependency axios to v1.7.3 (1ca77c6)
• types: update dependency type-fest to v4.22.0 (#20387) (47405dd)
• types: update dependency type-fest to v4.23.0 (#20396) (0e8e3c7)

9.11.2 (2024-07-10)

Bug Fixes

• types: update dependency type-fest to v4.21.0 (#20335) (8894b9a)

9.11.1 (2024-06-28)

Bug Fixes

• driver-test-support: update dependency @types/lodash to v4.17.6 (82e40c1)
• images-plugin: update dependency lru-cache to v10.3.0 (#20306) (e43c7a4)

9.11.0 (2024-06-27)

Features

• appium: Improve context logging (#20250) (f675abc)

Bug Fixes

• base-driver: Check if app path is relative earlier (#20276) (2882e71)
• base-driver: update dependency path-to-regexp to v7 (#20279) (a746eef)
• types: update dependency type-fest to v4.20.1 (#20255) (1984553)

9.10.3 (2024-06-11)

Note: Version bump only for package @appium/base-driver

9.10.2 (2024-06-11)

Note: Version bump only for package @appium/base-driver

9.10.1 (2024-06-11)

Note: Version bump only for package @appium/base-driver

9.10.0 (2024-06-10)

Features

• appium: Add session signature to all logs (#20202) (#20214) (0363aab), closes #20222

Bug Fixes

• driver-test-support: update dependency @types/lodash to v4.17.5 (69bbb53)
• types: update dependency type-fest to v4.20.0 (#20227) (ea00626)

9.9.0 (2024-06-06)

Features

• appium: Add session signature to all logs (#20202) (b3f8a47)

Bug Fixes

• appium: Revert changes in 20203 and 20202 (#20209) (40def9d), closes #20202 #20203

9.8.1 (2024-06-06)

Note: Version bump only for package @appium/base-driver

9.8.0 (2024-06-06)

Features

• base-driver: Make addition of search query params to cache optional (#20195) (21316e9)

Bug Fixes

• types: update dependency type-fest to v4.19.0 (#20193) (db62358)

9.7.0 (2024-05-27)

Features

• base-driver: Add env variables to control applications cache (#20042) (4e8c91c)
• base-driver: Add the original app link argument to configureApp callbacks (#20035) (3423fd9)

Bug Fixes

• base-driver: Update the web socket upgrade behavior (#20142) (275790e)
• driver-test-support: update definitelytyped (a8d36b0)
• images-plugin: update dependency lru-cache to v10.2.1 (#20039) (f645b50)
• images-plugin: update dependency lru-cache to v10.2.2 (#20052) (f8d1fb7)
• support: update dependency axios to v1.7.1 (11510cb)
• support: update dependency axios to v1.7.2 (a876f11)
• types: update dependency type-fest to v4.18.2 (#20103) (3b43be1)
• types: update dependency type-fest to v4.18.3 (#20149) (d5369f8)

9.6.0 (2024-04-21)

Features

• base-driver: Add onDownload handler to the configureApp helper (#20015) (8cf3efd)

9.5.4 (2024-04-16)

Bug Fixes

• do not print deprecation errors for non-provided caps (#19986) (9f655f6)

9.5.3 (2024-04-08)

Bug Fixes

• base-driver: update dependency express to v4.18.3 (917084c)
• base-driver: update dependency express to v4.19.1 (a74132c)
• base-driver: update dependency express to v4.19.2 (7cb1621)
• base-driver: update dependency path-to-regexp to v6.2.2 (#19979) (b8368bb)
• docutils: update dependency typescript to v5.4.2 (#19876) (2448fa0)
• driver-test-support: update definitelytyped (4776574)
• support: update dependency axios to v1.6.8 (bd6ab81)

9.5.2 (2024-02-13)

Note: Version bump only for package @appium/base-driver

9.5.1 (2024-02-06)

Bug Fixes

• images-plugin: update dependency lru-cache to v10 (#19723) (202da83)
• support: update dependency axios to v1.6.4 (332cc48)
• support: update dependency axios to v1.6.5 (#19616) (ac73522)
• support: update dependency axios to v1.6.6 (6313704)
• support: update dependency axios to v1.6.7 (795092a)
• types: update dependency type-fest to v4.10 (#19694) (966d305)
• types: update dependency type-fest to v4.10.1 (#19703) (501395c)

9.5.0 (2024-01-03)

Features

• add webdriver bidi support (2b21e66)

Bug Fixes

• base-driver: update dependency async-lock to v1.4.1 (a304a1f)
• support: update dependency axios to v1.6.3 (441b284)
• types: update dependency type-fest to v4 (#19592) (94b3580)

9.4.4 (2023-12-18)

Bug Fixes

• docutils: remove @appium/typedoc-plugin-appium and all other uses of typedoc (#19465) (7528fcf)
• images-plugin: update dependency lru-cache to v10 (#19490) (19c30b4)
• images-plugin: update dependency lru-cache to v10 (#19497) (4dd95c0)
• types: update dependency type-fest to v4 (#19104) (8bfa1b5)

9.4.3 (2023-12-04)

Bug Fixes

• support: update definitelytyped (2c02be4)
• support: update dependency axios to v1.6.2 (fda40e6)

9.4.2 (2023-11-14)

Bug Fixes

• support: update definitelytyped (5ae8df3)
• support: update dependency axios to v1.6.0 (699c493)
• support: update dependency axios to v1.6.1 (9b14205)

9.4.1 (2023-10-19)

Bug Fixes

• appium: Make sure type definitions are always in sync across modules (#19323) (de39013)
• support: update definitelytyped (a306ce7)

9.4.0 (2023-10-18)

Features

• base-driver: Add server support of TLS and SPDY protocols (#19105) (5926919)

Bug Fixes

• base-driver: update definitelytyped (5e09589)
• base-driver: update dependency http-status-codes to v2.3.0 (331171d)
• driver-test-support: update dependency @types/lodash to v4.14.198 (84fefd2)
• images-plugin: update dependency lru-cache to v10 (#19050) (72a806b)
• opencv: update definitelytyped (d2a9a99)
• support: update definitelytyped (3b44c7d)
• support: update definitelytyped (595d460)
• support: update definitelytyped (b6a76ce)
• support: update dependency axios to v1.5.0 (08913cd)
• support: update dependency axios to v1.5.1 (#19217) (3df047d)
• types: update definitelytyped (96b0a44)
• Use pathToRegexp to match websocket endpoints (#19162) (de02ed8)

9.3.20 (2023-08-23)

Bug Fixes

• base-driver: Avoid RangeError while caching the response data (#19043) (315a5e6)
• base-driver: fix the LRUCache.dispose callback param order (#19037) (abcf0d4)

9.3.19 (2023-08-22)

Note: Version bump only for package @appium/base-driver

9.3.18 (2023-08-21)

Bug Fixes

• base-driver: Fix possible NPE while cleaning up the state listener (#19020) (53bfc68)
• base-driver: Respect basic auth credentials if provided (#19000) (ed8e83c)
• driver-test-support: update dependency @types/lodash to v4.14.197 (a080b72)

9.3.17 (2023-08-17)

Bug Fixes

• base-driver: Tune responses caching logic (#18922) (de5b55a)
• driver-test-support: update definitelytyped (c320e8a)
• support: update dependency glob to v10 (#18490) (aaf31a5)
• test-support: update dependency @colors/colors to v1.6.0 (1358937)
• types: update dependency type-fest to v3.13.1 (fb34ab9)

9.3.16 (2023-07-24)

Bug Fixes

• base-driver: Use proper cached headers for app download (#18874) (75650a6)

9.3.15 (2023-07-03)

Bug Fixes

• base-driver: allow subclass to define shape of settings object (3d614d6)
• base-driver: pass thru all type args to ExternalDriver (2b35170)
• types,base-driver: remove deviceName from base constraints (01061b2)
• types: separate the type of opts from initialOpts (d6cca51)

9.3.14 (2023-06-29)

Note: Version bump only for package @appium/base-driver

9.3.13 (2023-06-15)

Bug Fixes

• base-driver: update def of findElOrEls and findElOrElsWithProcessing (54a4a8d)
• types: various fixes for reality (81bc527)

9.3.12 (2023-06-14)

Note: Version bump only for package @appium/base-driver

9.3.11 (2023-06-14)

Bug Fixes

• schema: update definitelytyped (e967240)
• types: update dependency type-fest to v3.11.0 (19277f6)
• types: update dependency type-fest to v3.11.1 (56499eb)

9.3.10 (2023-05-19)

Bug Fixes

• base-driver: add missing @types/lodash (63a429c)

9.3.9 (2023-05-19)

Note: Version bump only for package @appium/base-driver

9.3.8 (2023-05-17)

Bug Fixes

• base-driver: Ignore unknown script arguments (#18575) (4f564ef)
• support: update dependency axios to v1.3.6 (6692227)
• support: update dependency axios to v1.4.0 (91a6bc5)
• types: update dependency type-fest to v3.10.0 (3c4d3ac)
• types: update dependency type-fest to v3.9.0 (94a207f)

9.3.7 (2023-04-14)

Bug Fixes

• basedriver: allow arbitrary session data to be returned by getSession (6245022)

9.3.6 (2023-04-10)

Bug Fixes

• support: update dependency axios to v1.3.5 (6cf1480)
• types: update dependency type-fest to v3.8.0 (d6c42e9)

9.3.5 (2023-04-03)

Bug Fixes

• types: update dependency type-fest to v3.7.2 (5580539)

9.3.4 (2023-03-28)

Bug Fixes

• appium,types,base-driver,fake-driver,driver-test-support: normalize constraint defaults (3c9fa7b)
• backwards-compatible fixes for TS v5.x (4974403)
• base-driver,base-plugin,types: update PluginCommand and DriverCommand types (0dcd5fa)
• base-driver,types: fix websocket-related types on AppiumServer (34891f5)
• base-driver: fix timeout mixin to use proper context types (51a8f2f)
• base-driver: misc type fixes (d303527)
• basedriver: convert main driver implementation to typescript (deb631b), closes #18379 #18379
• types: update dependency type-fest to v3.7.0 (6912fa1)
• types: update dependency type-fest to v3.7.1 (bc860c7)

9.3.3 (2023-03-08)

Bug Fixes

• base-driver: remove needless static prop breaking the build (1b70551)
• base-driver: use new mixin strategy (be86627)
• images-plugin: update dependency lru-cache to v7.17.2 (d1d5ece)
• images-plugin: update dependency lru-cache to v7.18.1 (ed1d3aa)
• images-plugin: update dependency lru-cache to v7.18.2 (48c3311)
• images-plugin: update dependency lru-cache to v7.18.3 (01bff49)
• types: update dependency type-fest to v3.6.1 (471a4b5)

9.3.2 (2023-02-24)

Bug Fixes

• appium:options should work via --default-capabilities (11e7ad0), closes #18191
• base-driver: fix type problem w/r/t axios headers (61a0275)
• base-driver: update dependency body-parser to v1.20.2 (1cb01a5)
• images-plugin: update dependency lru-cache to v7.15.0 (4cf8dbc)
• images-plugin: update dependency lru-cache to v7.16.0 (d54901a)
• images-plugin: update dependency lru-cache to v7.16.1 (2fa6bf1)
• images-plugin: update dependency lru-cache to v7.16.2 (4b10322)
• images-plugin: update dependency lru-cache to v7.17.0 (eb73be8)
• support: update dependency axios to v1.3.4 (49f157d)
• types: update dependency type-fest to v3.5.7 (b4416c5)
• types: update dependency type-fest to v3.6.0 (08a6f3a)
• update axios to v1.3.3 (8f9de63)

9.3.1 (2023-02-09)

Bug Fixes

• base-driver,driver-test-support,support: update types for axios@1.2.3 (c5451e4)
• base-driver: update definitelytyped (c2289ad)
• support: update dependency axios to v1.2.3 (20c176b)
• types: update definitelytyped (172bdae)
• types: update dependency @types/express to v4.17.16 (644f300)
• types: update dependency type-fest to v3.5.4 (cfb5297)
• types: update dependency type-fest to v3.5.5 (9bf320c)
• types: update dependency type-fest to v3.5.6 (775c990)

9.3.0 (2023-01-23)

Bug Fixes

• types: update dependency type-fest to v3.5.2 (64fd8ce)
• types: update dependency type-fest to v3.5.3 (6c4ba8c)

Features

• base-plugin: add ability for plugins to implement execute methods (84abed9)

9.2.3 (2023-01-13)

Note: Version bump only for package @appium/base-driver

9.2.2 (2023-01-13)

Note: Version bump only for package @appium/base-driver

9.2.1 (2023-01-13)

Note: Version bump only for package @appium/base-driver

9.2.0 (2023-01-13)

Bug Fixes

• appium: inability to find automationName inside appium:options (#17966) (23224cf)
• base-driver: add missing dependency @appium/types (edde488), closes #18006
• base-driver: move setClipboard deprecation to correct place (ad1dce5)
• support: update dependency axios to v1.2.2 (5291ca6)
• types: update dependency type-fest to v3.5.0 (8c8bfe8)
• types: update dependency type-fest to v3.5.1 (4b5ab4d)

Features

• base-driver: deprecate non-standard routes (7055a0b)
• typedoc-appium-plugin: implement cross-referencing of methods (8b33414)

9.1.0 (2022-12-21)

Bug Fixes

• add 'webSocketUrl' as standard cap for bidi support (#17936) (0e195ca)
• types: update definitelytyped (172fcb9)
• types: update dependency type-fest to v3.4.0 (37f71c3)

Features

• base: add get computed role and label in W3C v2 (#17928) (316ecca)

9.0.0 (2022-12-14)

Bug Fixes

• base-driver: ensure caps is defined (1e00faf)

• base-driver: Properly validate capabilities inside appium:options map (#17781) (9190115)

• base-driver: update type for logExtraCaps (28876c1)

• basedriver,types: fix type problems (226cd01)

• fake-driver: update dependency asyncbox to v2.9.4 (70a9c14)

• images-plugin: update dependency lru-cache to v7.14.1 (0d7c936)

• opencv: update definitelytyped (32557f4)

• support: update dependency axios to v1.2.0 (b80b88b)

• support: update dependency axios to v1.2.1 (07d6ef6)

• types: update dependency type-fest to v3.2.0 (f5da9f3)

• types: update dependency type-fest to v3.3.0 (33aef07)

• chore!: set engines to minimum Node.js v14.17.0 (a1dbe6c)

Features

• experimental support for typedoc generation (4746080)

BREAKING CHANGES

• Appium now supports version range ^14.17.0 || ^16.13.0 || >=18.0.0

8.7.3 (2022-10-14)

Bug Fixes

• basedriver: ensure "opts" is defined at time of construction (51d6d69)

8.7.2 (2022-10-13)

Note: Version bump only for package @appium/base-driver

8.7.1 (2022-09-07)

Note: Version bump only for package @appium/base-driver

8.7.0 (2022-08-10)

Features

• appium,base-driver,fake-driver,fake-plugin,test-support,types: updateServer receives cliArgs param (d4b9833), closes #17304
• base-driver,fake-driver,appium: add convenience methods for defining execute script overloads (#17321) (337ec3e)

8.6.1 (2022-08-03)

Bug Fixes

• appium,base-driver,base-plugin,doctor,docutils,eslint-config-appium,execute-driver-plugin,fake-driver,fake-plugin,gulp-plugins,images-plugin,opencv,relaxed-caps-plugin,schema,support,test-support,types,universal-xml-plugin: update engines (d8d2382)

8.6.0 (2022-07-28)

Bug Fixes

• moved type packages to deps of specific packages (f9129df)

Features

• appium,base-driver,base-plugin,test-support,types: move test fixtures into test-support (70d88cb)

8.5.7 (2022-06-04)

Note: Version bump only for package @appium/base-driver

8.5.6 (2022-06-03)

Bug Fixes

• base-driver: don't assign log to jwproxy from opts (eae3efd)

8.5.5 (2022-05-31)

Note: Version bump only for package @appium/base-driver

8.5.4 (2022-05-31)

Bug Fixes

• appium: fix extension autoinstall postinstall script (3e2c05d), closes #16924

8.5.3 (2022-05-02)

Note: Version bump only for package @appium/base-driver

8.5.2 (2022-04-20)

Note: Version bump only for package @appium/base-driver

8.5.1 (2022-04-20)

Note: Version bump only for package @appium/base-driver

8.5.0 (2022-04-20)

Bug Fixes

• base-driver: do not throw if updateSettings aren't provided (2d76923)
• base-driver: supportedLogTypes does not get overwritten (ab6dfb3), closes #16738

Features

• base-driver: Add a route for new window creation (#16748) (78a4637)

8.4.2 (2022-04-12)

Note: Version bump only for package @appium/base-driver

8.4.1 (2022-04-12)

Bug Fixes

• base-driver: isErrorType import (ad3b4b2)
• base-driver: Make sure proxyReqRes helper never throws any exceptions (#16742) (5d2156a)

8.4.0 (2022-04-07)

Bug Fixes

• base-driver: Make sure we never mutate incoming args (#16670) (c63e9bf)
• base-driver: Update/simplify the logic for logger prefix (#16683) (a9651d3)

Features

• base-driver: Add more shadow root-related W3C routes (#16700) (d8a9b4d)
• base-driver: generate declaration files (164bedb)

8.3.1 (2022-03-23)

Bug Fixes

• base-driver: Use WeakRef to reference the driver instance in the log prefix generator (#16636) (bbfc7ef)

8.3.0 (2022-03-22)

Bug Fixes

• remove BASEDRIVER_HANDLED_SETTINGS (#16368) (5aae1ae)
• revert 15809 (#16621) (3ee93ba)
• Update property name after lru-cache package bump (#16446) (1165269)

Features

• Add a missing route for element shadow root (#16538) (493c48d)
• base-driver: Add the size validation of the passed settings objects (#16420) (a881ae9)

8.2.4 (2022-01-21)

Note: Version bump only for package @appium/base-driver

8.2.3 (2022-01-11)

Bug Fixes

• appium: fix incorrect handling of delete session with regard to plugin driver assignment (7b3893a)
• base-driver: follow W3C capabilities more strictly (#16193) (9a85a41)
• Switch colors package to a non-compomised repository (#16317) (40a6f05)

8.2.2 (2021-11-23)

Note: Version bump only for package @appium/base-driver

8.2.1 (2021-11-19)

Bug Fixes

• base-driver: create cjs wrapper (85cd55b)

8.2.0 (2021-11-15)

Bug Fixes

• appium: fix interaction of plugins with proxying (7091008)

Features

• fake-driver: add a new 'PROXY' context that does 'proxying' for use in testing (9e6c0a1)

8.1.2 (2021-11-09)

Bug Fixes

• base-driver: allow https in helper URL generation (cf86871)
• base-driver: better URL handling in driver-e2e tests (01d7c1b)
• base-driver: type inconsistency (#15982) (0e63393)

8.1.1 (2021-09-16)

Note: Version bump only for package @appium/base-driver

8.1.0 (2021-09-16)

Features

• base-driver: allow drivers, and plugins to declare that certain routes must never be proxied (3e5aec9)

8.0.3 (2021-09-15)

Note: Version bump only for package @appium/base-driver

8.0.2 (2021-09-14)

Note: Version bump only for package @appium/base-driver

8.0.1 (2021-09-14)

Note: Version bump only for package @appium/base-driver

8.0.0-beta.7 (2021-08-16)

2.0.0-beta (2021-08-13)

chore

• update @appium/fake-driver to use @appium/base-driver (#15436) (c66144d), closes #15425

Features

• appium: Add driver and plugin server arg injection feature (#15388) (d3c11e3)
• appium: expose validateCaps in basedriver index (#15451) (21e8d60)
• base-driver: prefer system unzip (25cc27d)

Reverts

• base-driver: "chore: merge base-driver master (de7e41b) to base-driver for 2.0" (#15454) (254cc63)

BREAKING CHANGES

• fake-driver now depends upon @appium/base-driver@8.x

@appium/fake-driver

• need to use w3c capabilities only
• fix: find app.xml fixture properly when running tests via mocha --require=@babel/register

@appium/base-driver

• fixed a dead URL in a comment
• updated the "logging" tests to manually supply w3c capabilities. createSession() does it for you, but executeCommand('createSession') does not.
• display the name of the driver under test when executing base driver's test suite with other drivers