# devtools_shared 13.1.0 Package of shared Dart structures between devtools_app, dds, and other tools. ## Installing ``` export PUB_HOSTED_URL=https://pub.mirror.p-hatan.ir flutter pub add 'devtools_shared:13.1.0' ``` Published: 2026-07-16T15:18:19.269653Z Expected archive SHA-256: 13df2c17d5f21dd7c92d08145386d45e1153364c04e531e994afb0ee7b67554b Available in cache; verification: upstream_checksum ## Direct dependencies - args: ^2.4.2 - collection: ^1.15.0 - dtd: ^4.0.0 - extension_discovery: ^2.1.0 - file: ^7.0.0 - meta: ^1.9.1 - path: ^1.8.0 - shelf: ^1.1.0 - sse: ^4.1.2 - vm_service: >=13.0.0 <16.0.0 - web_socket_channel: >=2.4.0 <4.0.0 - webkit_inspection_protocol: >=0.5.0 <2.0.0 - yaml: ^3.1.2 - yaml_edit: ^2.1.1 ## Package README (untrusted upstream documentation) ## package:devtools_shared/devtools_shared.dart This is a package shared between devtools_app, dds, and external users accessing exported JSON files. This package contains structures describing the format of JSON files e.g., HeapSample, memory structures collected from the Dart VM (HeapSpace) and collected memory info from Android's ADB (AdbMemoryInfo). ## package:devtools_shared/devtools_server.dart An implementation of shared devtools server classes. ## Terms and Privacy By using Dart DevTools, you agree to the [Google Terms of Service](https://policies.google.com/terms). ## Changelog # 13.1.0 * The `LocalFileSystem` extension APIs are deprecated in favor of a new `FileSystemExtension` extension, which is based on the `FileSystem` class from the `file` package. In detail: * `fileSystem` is a new top-level constant which represents the local (real) file system. * `LocalFileSystem.devToolsDir()` is replaced by a static getter, `FileSystemExtension.devToolsDir`. * `LocalFileSystem.maybeMoveLegacyDevToolsStore()` is replaced by an instance method, `FileSystemExtension.maybeMoveLegacyDevToolsStore()`. * `LocalFileSystem.devToolsStoreLocation()` is replaced by a static getter, `FileSystemExtension.devToolsStoreLocation`. * `LocalFileSystem.ensureDevToolsDirectory()` will be removed. * `LocalFileSystem.devToolsFileFromPath()` is replaced by an instance method, `FileSystemExtension.devToolsFileFromPath()`. * `LocalFileSystem.devToolsFileAsJson()` is replaced by an instance method, `FileSystemExtension.devToolsFileAsJson()`. * `LocalFileSystem.flutterStoreExists()` is replaced by an instance getter, `FileSystemExtension.flutterStoreExists`. # 13.0.2 * Validate the `devtoolsOptionsUri` query parameter in the extension enabled state handler so it must be a `file:` URI named `devtools_options.yaml`, preventing arbitrary file writes by the DevTools server process. * The minimum Dart SDK version is bumped to 3.11.0. * The minimum Flutter SDK version is bumped to 3.41.0. # 13.0.1 * Handle null values for `FlutterStore.flutterClientId`. # 13.0.0 * **Breaking change:** Removed `DevToolsStoreKeys.analyticsEnabled` and `DevToolsStoreKeys.isFirstRun` since these were only used for legacy analytics. * **Breaking change:** Removed legacy analytics APIs and state cleanup (e.g. `apiGetFlutterGAEnabled`, `apiGetDevToolsEnabled`, `apiSetDevToolsEnabled`, `apiGetDevToolsFirstRun`, `apiResetDevTools`). * **Breaking change:** Removed public constant `devToolsEnabledPropertyName`. * **Breaking change:** Removed `isFirstRun`, `reset`, and `analyticsEnabled` from `DevToolsUsage`. # 12.1.0 * Adds additional logging to `IntegrationTestRunner`. * Fixes assertion error when parsing Flutter channel versions using the format `X.XX.X-X.X.pre-XXX`. * Fixes breakage associated with ChromeDriver 138 when using `IntegrationTestRunner`. * Adds `sanitizeVersionStr` helper to `SemanticVersion`. * Fixes null error when parsing `bundleIdentifier` or `teamIndentifier` in `UniversalLinkSettings`. # 12.0.0 * Update `dtd` dependency to `^4.0.0`. * Register and unregister VM service connections on DTD. This change only applies to the case where the DevTools server starts DTD (i.e. when a DTD connection was not passed to the server on startup). # 11.2.1 * Rename `Handler` extension methods to `VmServiceHandler`. This member was marked `@visibleForTesting` and should not be used outside of this package, so we consider this change non-breaking. # 11.2.0 * Bump `vm_service` dependency upper bound to `<16.0.0`. # 11.1.0 * Bump minimum SDK version to `3.6.0`. * Update `package:vm_service` to `>=13.0.0 <16.0.0`. # 11.0.0 * **Breaking change:** replace `apiGetLastReleaseNotesVersion` with `ReleaseNotesApi.getLastReleaseNotesVersion`. * **Breaking change:** replace `apiSetLastReleaseNotesVersion` with `ReleaseNotesApi.setLastReleaseNotesVersion`. * **Breaking change:** replace `lastReleaseNotesVersionPropertyName`. * **Breaking change:** replace `apiGetBaseAppSizeFile` with `AppSizeApi.getBaseAppSizeFile`. * **Breaking change:** replace `apiGetTestAppSizeFile` with `AppSizeApi.getTestAppSizeFile`. * **Breaking change:** replace `baseAppSizeFilePropertyName` with `AppSizeApi.baseAppSizeFilePropertyName`. * **Breaking change:** replace `testAppSizeFilePropertyName` with `AppSizeApi.testAppSizeFilePropertyName`. * **Breaking change:** replace `apiSetActiveSurvey` with `SurveyApi.setActiveSurvey`. * **Breaking change:** remove `activeSurveyName`. * **Breaking change:** replace `apiGetSurveyActionTaken` with `SurveyApi.getSurveyActionTaken`. * **Breaking change:** replace `apiSetSurveyActionTaken` with `SurveyApi.setSurveyActionTaken`. * **Breaking change:** remove `surveyActionTakenPropertyName`. * **Breaking change:** replace `apiGetSurveyShownCount` with `SurveyApi.getSurveyShownCount`. * **Breaking change:** replace `apiIncrementSurveyShownCount` with `SurveyApi.incrementSurveyShownCount`. * Support Chrome's new headless mode in the integration test runner. * Add `PreferencesApi` to get and set preference values. * Deprecate `DTDConnectionInfo` in favor of `DtdInfo` which supports tracking two URIs for DTD to better support web/remote environments. # 10.0.2 * Update dependency `web_socket_channel: '>=2.4.0 <4.0.0'`. # 10.0.1 * Added helper `deserialize` and `deserializeNullable` * Extended serialization for `HeapSample` and `ExtensionEvents` * Added mixin `Serializable` * Fix a regression with accessing the Flutter store file. * Bump minimum Dart SDK version to Dart stable `3.4.3`. # 10.0.0-dev.2 * Support detecting package roots for nested Dart projects in the `packageRootFromFileUriString` utility method. # 10.0.0-dev.1 * Export `DTDConnectionInfo` from the `devtools_shared.dart` library instead of the `devtools_server.dart` library. # 10.0.0-dev.0 * **Breaking change:** rename `DevToolsExtensionConfig.path` to `DevToolsExtensionConfig.extensionAssetsPath` and update class documentation. * **Breaking change:** rename `ExtensionsApi.extensionRootPathPropertyName` to `ExtensionsApi.packageRootUriPropertyName`, and modify the String value for the parameter from 'rootPath' to 'packageRootUri'. * **Breaking change:** add new required JSON fields "devtoolsOptionsUri" and "detectedFromStaticContext" in the `DevToolsExtensionConfig.parse` factory constructor. * **Breaking change:** remove `DevToolsOptions.optionsFileName` constant in favor of new constant `devtoolsOptionsFileName`. * **Breaking change:** modify the `ExtensionsApi.apiExtensionEnabledState` API to expect a query parameter "devtoolsOptionsUri" instead of "rootPath". * **Breaking change:** replace the `rootUri` parameter in the `DevToolsOptions.lookupExtensionEnabledState` and `DevToolsOptions.setExtensionEnabledState` methods with new parameter `devtoolsOptionsUri`. Modify logic to expect a full file URI to the options file instead of expecting the package root in which it is contained. * Add new fields `requiresConnection`, `devtoolsOptionsUri`, and `detectedFromStaticContext` to `DevToolsExtensionConfig`. * Add `ExtensionsApi.devtoolsOptionsUriPropertyName` field. * Return valid extensions from the `apiServeAvailableExtensions` endpoint even when an exception is thrown. * Add utility extension methods on `Completer`: `safeComplete` and `safeCompleteError`. # 9.0.1 * Restructure `devtools_extensions.dart` and `devtools_extensions_io.dart` libraries. # 9.0.0 * **Breaking change:** remove parameter `analytics` from `ServerApi.handle` in favor of DTD implementation. * **Breaking change:** remove DevTools server APIs `apiMarkConsentMessageAsShown` and `apiGetConsentMessage` * **Breaking change:** remove parameter `buildDir` from `ExtensionsManager`. in favor of DTD implementation. * Stop copying DevTools extensions assets to the DevTools build directory. * Bump `package:dtd` to `2.2.0` * Remove `package:unified_analytics` dependency. * Use DTD in the `packageRootFromFileUriString` utility to detect the package root. * Add `runWithRetry` utility method. # 8.1.1 * Bump `package:dtd` to `2.1.0`. * Bump the minimum Dart SDK version to `3.4.0-282.1.beta`. # 8.1.0 * Bump `package:dtd` to `2.0.0`. * Bump `package:unified_analytics` to `5.8.8`. # 8.0.1 * **Breaking change:** rename `ServerApi.getCompleted` to `ServerApi.success` and make the `value` parameter optional. * **Breaking change:** remove the `String? dtdUri` parameter from `ServerApi.handle` and replace it with a parameter `DTDConnectionInfo? dtd`. * Introduce a new typedef `DTDConnectionInfo`. * Add a new API `apiNotifyForVmServiceConnection` that DevTools will call when a VM service connection is connected or disconnected from the client. * Add a helper method `packageRootFromFileUriString`. * Refactor yaml extension methods. * Add intent filters checking functionality for deep link validation. # 7.0.0 * **Breaking change:** remove the `ServerApi.setCompleted` method that was a duplicate of `ServerApi.getCompleted`. * **Breaking change:** add required parameter `analytics` to `ServerApi.handle`, which accepts an instance of `Analytics` from `package:unified_analytics`. * Add the ability to send debug logs in DevTools server request responses. * Add an optional positional parameter `logs` to the `ServerApi.serverError` method. * Include debug logs with the `ExtensionsApi.apiServeAvailableExtensions` API response. * Devtools server API `apiGetConsentMessage` added to fetch the consent message from `package:unified_analytics`. * Devtools server API `apiMarkConsentMessageAsShown` added to mark the consent message for `package:unified_analytics` as shown to enable telemetry. # 6.0.4 * Add `apiGetDtdUri` to the server api. * Add a description and link to documentation to the `devtools_options.yaml` file that is created in a user's project. # 6.0.3 * `CompareMixin` is now generic, implementing `Comparable` instead of `Comparable`, and it's operators each therefore accept a `T` argument. * `SemanticVersion` now mixes in `CompareMixin`, and it's `compareTo` method therefore now accepts a `SemanticVersion`. * Fix an issue parsing file paths that could prevent extensions from being detected. * Bump `package:vm_service` dependency to `>=13.0.0 <15.0.0`. # 6.0.2 * Fix an issue parsing file paths on Windows that could prevent extensions from being detected. # 6.0.1 * Bump minimum Dart SDK version to `3.3.0-91.0.dev` and minimum Flutter SDK version to `3.17.0-0.0.pre`. * Add field `isPublic` to `DevToolsExtensionConfig`. * Add validation for `DevToolsExtensionConfig.name` field to ensure it is a valid Dart package name. * Pass warnings and errors for DevTools extension APIs from the DevTools server to DevTools app. # 6.0.0 * Bump `package:vm_service` dependency to ^13.0.0. * Remove `ServiceCreator` typedef and replace usages with `VmServiceFactory` typedef from `package:vm_service`. # 5.0.0 * Split deeplink exports into `devtools_deeplink_io.dart` and `devtools_deeplink.dart`. * Bump `package:vm_service` to ^12.0.0. * Adds `DeeplinkApi.androidAppLinkSettings`, `DeeplinkApi.iosBuildOptions`, and `DeeplinkApi.iosUniversalLinkSettings` endpoints to ServerApi. * Add shared integration test utilities to `package:devtools_shared`. These test utilities are exported as part of the existing `devtools_test_utils.dart` library. # 4.0.1 * Override equality operator and hashCode for `DevToolsExtensionConfig` to be based on the values of its fields. # 4.0.0 * Bump `package:extension_discovery` version to ^2.0.0 * Adds a `DeeplinkApi.androidBuildVariants` endpoint to ServerApi. * **BREAKING CHANGE**: - `ServerApi.handle` parameters `extensionsManager` and `api` were converted to named parameters - Adds a new required named parameter `deeplinkManager` to `ServerApi.handle`. # 3.0.1 * Bump `package:extension_discovery` version to ^1.0.1 # 3.0.0 * Separate extension-related libraries into those that require `dart:io` (exported as `devtools_extensions_io.dart`) and those that do not (exported as `devtools_extensions.dart`). Prior to version 3.0.0, `package:devtools_shared` was versioned in lockstep with `package:devtools_app`. Both of these packages are developed as part of the broader [DevTools project](https://github.com/flutter/devtools). To see changes and commits for `package:devtools_shared`, prior to version 3.0.0 please view the git log [here](https://github.com/flutter/devtools/commits/master/packages/devtools_shared).