Upgrading appium-safari-driver from 5.x to 6.x
Comparison of the public API of appium-safari-driver 5.0.11 and 6.0.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.
Summary
| Removed import paths | 0 |
|---|---|
| Removed exports | 1 |
| Changed signatures | 0 |
| Removed class or interface members | 0 |
| Changed class or interface members | 5 |
| Newly deprecated | 0 |
| Requirement changes (engines, peer dependencies) | 2 |
| New exports | 0 |
Removed exports
| import | export | kind | Before |
|---|---|---|---|
appium-safari-driver | default | class | class |
Changed signatures
None detected.
Removed class or interface members
None detected.
Changed class or interface members
| member | Before | After |
|---|---|---|
SafariDriver.findElOrEls | (this: SafariDriver, strategy: string, selector: string, mult: boolean, context?: string | undefined): Promise<any> | (strategy: string, selector: string, mult: boolean, context?: string | undefined): Promise<any> |
SafariDriver.createSession | (w3cCaps1: W3CDriverCaps<{ readonly browserName: { readonly isString: true; }; readonly browserVersion: { readonly isString: true; }; readonly acceptInsecureCerts: { readonly isBoolean: true; }; readonly 'safari:platformVersion': { readonly isString: true; }; readonly 'safari:platformBuildVersion': … | (w3cCapabilities: W3CDriverCaps<{ readonly browserName: { readonly isString: true; }; readonly browserVersion: { readonly isString: true; }; readonly acceptInsecureCerts: { readonly isBoolean: true; }; readonly 'safari:platformVersion': { readonly isString: true; }; readonly 'safari:platformBuildVer… |
SafariDriver.deleteCookies | (this: SafariDriver): Promise<any> | (): Promise<any> |
SafariDriver.stopRecordingScreen | (this: SafariDriver, options?: StopRecordingOptions | undefined): Promise<string> | (options?: StopRecordingOptions | undefined): Promise<string> |
SafariDriver.startRecordingScreen | (this: SafariDriver, options?: StartRecordingOptions | undefined): Promise<void> | (options?: StartRecordingOptions | undefined): Promise<void> |
Newly deprecated
None detected.
Requirement changes (engines, peer dependencies)
| Before | After | |
|---|---|---|
engines.node | ^20.19.0 || ^22.12.0 || >=24.0.0 | ^22.22.2 || ^24.15.0 || >=26.0.0 |
peerDependencies.appium | ^3.0.0-rc.2 | ^4.0.0-beta.6 |
Changelog between these versions
Text published by the package authors, shown as-is.
6.0.0
### ⚠ BREAKING CHANGES
* Requires Appium ^4.0.0-beta.6 (peer dependency). No longer compatible with Appium 3.
* Drops Node 20. The minimum is now ^22.22.2 || ^24.15.0 || >=26.0.0, matching Appium 4's engine range.
* Driver API: createSession takes a single w3cCapabilities argument, following the Appium 4 base driver. This only matters to anyone subclassing the driver.
* Default exports removed: the package no longer has a default export. Use the named export instead: import {SafariDriver} from 'appium-safari-driver'.
* Command methods live on the prototype: deleteCookies, findElOrEls, startRecordingScreen and stopRecordingScreen are attached to SafariDriver.prototype (with declare module typings) rather than being instance fields, so subclasses can call super for them.
### Features
* add Appium 4 support ([#204](https://github.com/appium/appium-safari-driver/issues/204)) ([bff1052](https://github.com/appium/appium-safari-driver/commit/bff1052803c0f1bb0903f9830d43260c8f4fcd6e))
### Code Refactoring
* use ConditionUnmetError instead of message matching ([#203](https://github.com/appium/appium-safari-driver/issues/203)) ([3206a56](https://github.com/appium/appium-safari-driver/commit/3206a569c00841887159eddf3c3dfcce1f1a4712))Give your AI agent these facts
Vigia is a free MCP server: your coding agent checks versions, breaking changes and vulnerabilities before it writes code. No signup, no API key.
claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp
Add to CursorAdd to VS Code★ Star on GitHub
Any other MCP client
{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }Agent skill (SKILL.md): tells the agent when to use Vigia · GitHub Action for pull requests
Frequently asked questions
What are the breaking changes when upgrading appium-safari-driver from 5 to 6?
Between appium-safari-driver 5.0.11 and 6.0.0, Vigia found 1 removed exports, 0 changed signatures and 5 removed or changed class or interface members.
What became deprecated in appium-safari-driver 6?
0 exports or members are newly marked as deprecated in appium-safari-driver 6.0.0.
For agents
GET https://vigia.coredls.cloud/v1/packages/npm/appium-safari-driver/upgrade?from=5.0.11&to=6.0.0