@metamask/snaps-controllers 0.32.2 → 0.33.1-flask.1

package/CHANGELOG.md

@@ -0,0 +1,575 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.33.1-flask.1]
+### Fixed
+- Skip subjects without the `wallet_snap` permission in `removeSnapFromSubject` ([#1388](https://github.com/MetaMask/snaps-monorepo/pull/1388))
+
+## [0.33.0-flask.1]
+### Changed
+- Add subject type restrictions to snap-specific permissions ([#1366](https://github.com/MetaMask/snaps-monorepo/pull/1366))
+- Add console endowment that prepends snap IDs to log output ([#1355](https://github.com/MetaMask/snaps-monorepo/pull/1355))
+- Add `DisconnectOrigin` action ([#1329](https://github.com/MetaMask/snaps-monorepo/pull/1329))
+- Add Web Worker support for snap execution ([#1320](https://github.com/MetaMask/snaps-monorepo/pull/1320))
+
+## [0.32.2]
+### Fixed
+- Properly handle Promise in `JsonSnapsRegistry` signature verification ([#1317](https://github.com/MetaMask/snaps-monorepo/pull/1317))
+
+## [0.32.1]
+### Changed
+- No changes this release.
+
+## [0.32.0]
+### Added
+- Add verification of registry signature ([#1291](https://github.com/MetaMask/snaps-monorepo/pull/1291))
+- Add types to result approvals ([#1288](https://github.com/MetaMask/snaps-monorepo/pull/1288))
+
+### Changed
+- **BREAKING:** Convert registry to a caching controller ([#1305](https://github.com/MetaMask/snaps-monorepo/pull/1305))
+- **BREAKING:** Require snaps to request at least one handler permission ([#1294](https://github.com/MetaMask/snaps-monorepo/pull/1294))
+- Use side effects to install snaps via `wallet_snap` permission ([#1301](https://github.com/MetaMask/snaps-monorepo/pull/1301))
+
+### Fixed
+- Fix a few issues with installation and updating ([#1308](https://github.com/MetaMask/snaps-monorepo/pull/1308))
+
+## [0.31.0]
+### Changed
+- **BREAKING:** Target `ES2020` ([#1247](https://github.com/MetaMask/snaps-monorepo/pull/1247))
+- **BREAKING:** Combine snap installation popups ([#1261](https://github.com/MetaMask/snaps-monorepo/pull/1261))
+- Throw errors on failed `fetch` ([#1227](https://github.com/MetaMask/snaps-monorepo/pull/1227))
+- Improve validation and sanitizing of snap IDs ([#1237](https://github.com/MetaMask/snaps-monorepo/pull/1237))
+
+### Fixed
+- Fix smaller installation issues affecting local snaps ([#1248](https://github.com/MetaMask/snaps-monorepo/pull/1248))
+
+## [0.30.0]
+### Added
+- Add WebAssembly permission ([#1185](https://github.com/MetaMask/snaps-monorepo/pull/1185))
+
+### Fixed
+- Fix an issue with removing snaps ([#1194](https://github.com/MetaMask/snaps-monorepo/pull/1194))
+  - Previously, the `SnapController` was not requesting revocation of the `wallet_snap` permission from the `PermissionController` if an origin no longer had any permitted snaps, logic has been updated to account for this
+
+## [0.29.0]
+### Added
+- Add method to get metadata from the Snaps registry ([#1173](https://github.com/MetaMask/snaps-monorepo/pull/1173))
+- Set pre-fetch NPM tarball size limit ([#1169](https://github.com/MetaMask/snaps-monorepo/pull/1169))
+  - NPM packages now have a size limit of 250 MB
+
+### Changed
+- **BREAKING:** Updated controllers to accomodate new `wallet_snap` permission ([#1182](https://github.com/MetaMask/snaps-monorepo/pull/1182))
+- **BREAKING:** Change checksum calculation ([#1128](https://github.com/MetaMask/snaps-monorepo/pull/1128))
+  - The checksum has changed for all snaps, and needs to be updated
+
+## [0.28.0]
+### Added
+- Add `endowment:long-running` deprecation warning ([#1126](https://github.com/MetaMask/snaps-monorepo/pull/1126))
+- Add experimental offscreen execution environment ([#1082](https://github.com/MetaMask/snaps-monorepo/pull/1082))
+
+### Changed
+- **BREAKING:** Add support for snap registries ([#1090](https://github.com/MetaMask/snaps-monorepo/pull/1090))
+  - This removes the `checkBlockList` constructor argument in favor of `registry`
+  - A registry implementation can be passed here, defaulting to a hosted JSON file
+  - Requiring a snap to be on the allowlist can be toggled with the feature flag `requireAllowlist`
+- **BREAKING:** Disallow local snaps by default ([#1123](https://github.com/MetaMask/snaps-monorepo/pull/1123))
+  - They can be re-enabled by using the feature flag `allowLocalSnaps`
+- Allow updating crashed snaps ([#1113](https://github.com/MetaMask/snaps-monorepo/pull/1113))
+- Add safety measures for malicious tarballs  ([#1116](https://github.com/MetaMask/snaps-monorepo/pull/1116))
+- Make `installSnaps` throw on excluded permissions ([#1125](https://github.com/MetaMask/snaps-monorepo/pull/1125))
+
+### Removed
+- **BREAKING:** Remove `WebSocket` endowment ([#1122](https://github.com/MetaMask/snaps-monorepo/pull/1122))
+
+## [0.27.1]
+### Changed
+- No changes this release.
+
+## [0.27.0]
+### Changed
+- **BREAKING:** Use SIP-6 algorithm for state encryption ([#1055](https://github.com/MetaMask/snaps-monorepo/pull/1055))
+  - This breaks all existing snaps that use `snap_manageState`
+
+## [0.26.2]
+### Changed
+- No changes this release.
+
+## [0.26.1]
+### Fixed
+- Fix some paths being wrongly normalized ([#1053](https://github.com/MetaMask/snaps-monorepo/pull/1053))
+- Fix some issues with fetching snaps ([#1050](https://github.com/MetaMask/snaps-monorepo/pull/1050))
+
+## [0.26.0]
+### Changed
+- **BREAKING:** Snap installation refactor ([#1023](https://github.com/MetaMask/snaps-monorepo/pull/1023))
+  - `wallet_requestSnaps` will now throw an error and roll back any changes made if installation of any snap fails
+
+### Fixed
+- Fix an issue processing non-snap permissions ([#1044](https://github.com/MetaMask/snaps-monorepo/pull/1044))
+
+## [0.25.0]
+### Added
+- **BREAKING:** Add JSON-RPC handler permission ([#905](https://github.com/MetaMask/snaps-monorepo/pull/905))
+  - Snaps are now required to request `endowment:rpc` to receive RPC requests.
+- Add transaction origin caveat export ([#1010](https://github.com/MetaMask/snaps-monorepo/pull/1010))
+
+## [0.24.1]
+### Changed
+- No changes this release.
+
+## [0.24.0]
+### Added
+- Add transaction insight caveat for accessing transaction origin ([#902](https://github.com/MetaMask/snaps-monorepo/pull/902))
+
+### Changed
+- **BREAKING:** Rename package to start with `snaps-` ([#937](https://github.com/MetaMask/snaps-monorepo/pull/937))
+- **BREAKING:** Remove `wallet` global in favor of `snap` and `ethereum` ([#939](https://github.com/MetaMask/snaps-monorepo/pull/939))
+- Add permission validation to `snap.manifest.json` ([#910](https://github.com/MetaMask/snaps-monorepo/pull/910))
+
+## [0.23.0]
+### Added
+- Add snap cronjobs ([#651](https://github.com/MetaMask/snaps-monorepo/pull/651), [#890](https://github.com/MetaMask/snaps-monorepo/pull/890))
+
+### Changed
+- **BREAKING:** Make `SnapController.add()` private ([#883](https://github.com/MetaMask/snaps-monorepo/pull/883))
+- **BREAKING:** Stop including snap state in SnapController state ([#876](https://github.com/MetaMask/snaps-monorepo/pull/876))
+- **BREAKING:** Stop including source code in SnapController state ([#861](https://github.com/MetaMask/snaps-monorepo/pull/861))
+- Improve keyring endowment error messaging ([#884](https://github.com/MetaMask/snaps-monorepo/pull/884))
+- Replace JSON schema validation with structs ([#862](https://github.com/MetaMask/snaps-monorepo/pull/862))
+
+## [0.22.3]
+### Changed
+- No changes this release.
+
+## [0.22.2]
+### Fixed
+- Fix an issue with installing snaps that request the `eth_accounts` permission ([#839](https://github.com/MetaMask/snaps-monorepo/pull/839))
+
+## [0.22.1]
+### Fixed
+- Assert that multichain RPC methods are supported before usage ([#814](https://github.com/MetaMask/snaps-monorepo/pull/814))
+
+## [0.22.0]
+### Added
+- Add Snap Keyring support ([#700](https://github.com/MetaMask/snaps-monorepo/pull/700), [#775](https://github.com/MetaMask/snaps-monorepo/pull/775), [#777](https://github.com/MetaMask/snaps-monorepo/pull/777), [#740](https://github.com/MetaMask/snaps-monorepo/pull/740))
+  - Add `endowment:keyring` permission
+  - Add `MultiChainController`
+
+### Changed
+- **BREAKING:** Renamed `SnapController:getSnaps` to `SnapController:getPermittedSnaps` [#775](https://github.com/MetaMask/snaps-monorepo/pull/775)
+
+## [0.21.0]
+### Changed
+- **BREAKING:** Add changes to support blocking snaps by shasum ([#767](https://github.com/MetaMask/snaps-monorepo/pull/767))
+- **BREAKING:** Rework snap install logic ([#754](https://github.com/MetaMask/snaps-monorepo/pull/754))
+- Stop including `installing` snaps in `wallet_getSnaps` ([#765](https://github.com/MetaMask/snaps-monorepo/pull/765))
+
+### Fixed
+- Process snap permissions before snap update ([#753](https://github.com/MetaMask/snaps-monorepo/pull/753))
+- Only pause running timers ([#725](https://github.com/MetaMask/snaps-monorepo/pull/725))
+
+## [0.20.0]
+### Added
+- **BREAKING:** Add Transaction Insight API ([#642](https://github.com/MetaMask/snaps-monorepo/pull/642))
+  - This feature required changes to the RPC request handling functionality, hence the breaking change
+- Register missing actions ([#659](https://github.com/MetaMask/snaps-monorepo/pull/659))
+  - All APIs accessed outside the SnapController are now registered as actions in the messaging system
+
+### Changed
+- **BREAKING:** Simplify manifest format for permission caveats ([#705](https://github.com/MetaMask/snaps-monorepo/pull/705))
+- Reduce TypeScript compilation target for `snap-controllers` ([#708](https://github.com/MetaMask/snaps-monorepo/pull/708))
+- Move all internal types from `@metamask/snaps-types` to `@metamask/snaps-utils` ([#695](https://github.com/MetaMask/snaps-monorepo/pull/695))
+
+### Removed
+- **BREAKING:** Removed ExternalResourceController ([#701](https://github.com/MetaMask/snaps-monorepo/pull/701))
+
+## [0.19.1]
+### Changed
+- No changes this release.
+
+## [0.19.0]
+### Fixed
+- Fixed update snap approval missing metadata ([#673](https://github.com/MetaMask/snaps-monorepo/pull/673))
+- Fixed executors sending malformed JSON-RPC notifications ([#639](https://github.com/MetaMask/snaps-monorepo/pull/639))
+
+## [0.18.1]
+### Changed
+- No changes this release.
+
+## [0.18.0]
+### Changed
+- Reduce TypeScript compilation target to ES2017 ([#628](https://github.com/MetaMask/snaps-monorepo/pull/628))
+- **BREAKING:** Add browser entrypoint for execution services ([#629](https://github.com/MetaMask/snaps-monorepo/pull/629))
+  - Node.js execution services are now omitted in browser environments
+
+## [0.17.0]
+### Added
+- Add snap blocklist functionality ([#597](https://github.com/MetaMask/snaps-monorepo/pull/597))
+- Add Node.js `worker_threads` execution environment ([#587](https://github.com/MetaMask/snaps-monorepo/pull/587))
+- Add Node.js `child_process` execution environment ([#523](https://github.com/MetaMask/snaps-monorepo/pull/523))
+- Added network endowment teardown ([#514](https://github.com/MetaMask/snaps-monorepo/pull/514))
+
+### Changed
+- **BREAKING:** Bump minimum Node version to 16 ([#601](https://github.com/MetaMask/snaps-monorepo/pull/601))
+- **BREAKING:** Remove ExecutionService actions from constructor arguments ([#486](https://github.com/MetaMask/snaps-monorepo/pull/486))
+- **BREAKING:** Emit appropriate snap objects for SnapController events ([#608](https://github.com/MetaMask/snaps-monorepo/pull/608))
+- **BREAKING:** Replace `getRpcMessageHandler` action with `handleRpcRequest` ([#497](https://github.com/MetaMask/snaps-monorepo/pull/497), [#557](https://github.com/MetaMask/snaps-monorepo/pull/557))
+- Monitor outbound snap requests to pause request timeout ([#593](https://github.com/MetaMask/snaps-monorepo/pull/593))
+- Change Update Snap `requestData` ([#614](https://github.com/MetaMask/snaps-monorepo/pull/614))
+
+### Removed
+- Remove WebWorker implementation ([#591](https://github.com/MetaMask/snaps-monorepo/pull/591))
+
+## [0.16.0]
+### Added
+- **BREAKING:** Encrypt Snap state by default ([#369](https://github.com/MetaMask/snaps-monorepo/pull/369))
+  - Breaks existing installed snaps that use `snap_manageState`. All such Snaps must be reinstalled.
+
+### Changed
+- **BREAKING:** Snaps are now required to export `onRpcRequest` to receive RPC requests ([#481](https://github.com/MetaMask/snaps-monorepo/pull/481), [#533](https://github.com/MetaMask/snaps-monorepo/pull/533), [#538](https://github.com/MetaMask/snaps-monorepo/pull/538))
+  - The type of the function is available in `@metamask/snaps-types` as `OnRpcRequestHandler`.
+- Snaps can no longer run timers outside of pending RPC requests ([#490](https://github.com/MetaMask/snaps-monorepo/pull/490))
+
+### Fixed
+- Allow version matching with prerelease versions ([#508](https://github.com/MetaMask/snaps-monorepo/pull/508))
+- Fix issue with iframe error reporting ([#501](https://github.com/MetaMask/snaps-monorepo/pull/501))
+- Fix an issue with file paths with leading `./` in npm snap manifests ([#537](https://github.com/MetaMask/snaps-monorepo/pull/537))
+
+## [0.15.0]
+### Fixed
+- Fix an issue with detecting iframe execution environment load ([#464](https://github.com/MetaMask/snaps-monorepo/pull/464))
+
+## [0.14.0]
+### Changed
+- **BREAKING:** Increase TypeScript compilation target to ES2020 ([#449](https://github.com/MetaMask/snaps-monorepo/pull/449))
+  - This should not be breaking for consumers on any non-deprecated browser or Node.js version.
+
+## [0.13.0]
+### Added
+- Add long-running endowment permission ([#386](https://github.com/MetaMask/snaps-monorepo/pull/386))
+- Add `network-access` endowment from `controllers` ([#439](https://github.com/MetaMask/snaps-monorepo/pull/439))
+
+### Changed
+- **BREAKING:** Rename SnapController constructor argument ([#435](https://github.com/MetaMask/snaps-monorepo/pull/435))
+
+## [0.12.0]
+### Added
+- Add support for endowment teardown ([#407](https://github.com/MetaMask/snaps-monorepo/pull/407))
+- Emit `snapTerminated` event ([#406](https://github.com/MetaMask/snaps-monorepo/pull/406))
+- Add `IframeExecutionService` previously published via `@metamask/iframe-execution-environment-service` ([#415](https://github.com/MetaMask/snaps-monorepo/pull/415))
+
+### Removed
+- Remove `_createWindowTimeout` ([#404](https://github.com/MetaMask/snaps-monorepo/pull/404))
+- Remove unresponsive timeout ([#395](https://github.com/MetaMask/snaps-monorepo/pull/395))
+
+### Fixed
+- Correctly categorize ungracefully terminated snaps as crashed ([#427](https://github.com/MetaMask/snaps-monorepo/pull/427))
+
+## [0.11.1]
+### Changed
+- Always bind `fetch` by default ([#402](https://github.com/MetaMask/snaps-monorepo/pull/402))
+
+## [0.11.0]
+### Added
+- Add clearSnapState ([#346](https://github.com/MetaMask/snaps-monorepo/pull/346))
+
+### Changed
+- Robustify snap startup procedure and iframe error handling ([#379](https://github.com/MetaMask/snaps-monorepo/pull/379))
+- Added ability to update snaps when installing them ([#322](https://github.com/MetaMask/snaps-monorepo/pull/322))
+- **BREAKING:** Use PermissionController:revokePermissionForAllSubjects ([#351](https://github.com/MetaMask/snaps-monorepo/pull/351))
+- Changed console.logs to console.info ([#361](https://github.com/MetaMask/snaps-monorepo/pull/361))
+- Upgraded TypeScript version to minimum 4.4 ([#360](https://github.com/MetaMask/snaps-monorepo/pull/360))
+- Remove cross-fetch ([#349](https://github.com/MetaMask/snaps-monorepo/pull/349))
+
+### Fixed
+- Fix idle timeout implementation ([#385](https://github.com/MetaMask/snaps-monorepo/pull/385))
+
+## [0.10.7]
+### Added
+- Add version history information ([#317](https://github.com/MetaMask/snaps-monorepo/pull/317))
+- Add setInterval and clearInterval as default endowments ([#326](https://github.com/MetaMask/snaps-monorepo/pull/326))
+- Add queue for RPC requests to starting snaps ([#288](https://github.com/MetaMask/snaps-monorepo/pull/288))
+  - This improves the experience of invoking a starting snap, waiting for the snap to be ready instead of throwing an error.
+
+### Changed
+- **BREAKING:** Bump minimum Node version from 12 to 14 ([#331](https://github.com/MetaMask/snaps-monorepo/pull/331))
+
+## [0.10.6]
+### Fixed
+- Fix ID validation during Snap installation ([#308](https://github.com/MetaMask/snaps-monorepo/pull/308))
+
+## [0.10.5]
+### Added
+- Add updateSnap function to SnapController ([#259](https://github.com/MetaMask/snaps-monorepo/pull/259))
+
+### Fixed
+- Fix issue where installation errors were repeatedly thrown ([#301](https://github.com/MetaMask/snaps-monorepo/pull/301))
+- Fix snap crash handling ([#298](https://github.com/MetaMask/snaps-monorepo/pull/298))
+
+## [0.10.3]
+### Changed
+- Always reinstall local snaps ([#289](https://github.com/MetaMask/snaps-monorepo/pull/289))
+
+## [0.10.2]
+### Fixed
+- Installation failure ([#279](https://github.com/MetaMask/snaps-monorepo/pull/279))
+  - A faulty installation script in a dependency caused the installation of this package to fail.
+
+## [0.10.1]
+### Changed
+- Populate `jsonrpc` field in Snap RPC requests ([#273](https://github.com/MetaMask/snaps-monorepo/pull/273))
+
+### Fixed
+- Various bugs ([#275](https://github.com/MetaMask/snaps-monorepo/pull/275))
+  - Snap fetching during installation.
+  - Snap removal when cancelling a Snap installation request.
+
+## [0.10.0]
+### Added
+- Allow specifying a version range when installing snap ([#250](https://github.com/MetaMask/snaps-monorepo/pull/250))
+- Add more safe default endowments to snaps ([#252](https://github.com/MetaMask/snaps-monorepo/pull/252))
+
+### Changed
+- **BREAKING:** Specify all endowments in the `SnapController` ([#252](https://github.com/MetaMask/snaps-monorepo/pull/252)), ([#266](https://github.com/MetaMask/snaps-monorepo/pull/266))
+  - Previously, default endowments were specified in the execution environment. Now, default endowments are specified in the `SnapController`, and the execution environment will only add endowments specified by the execution command, except for the `wallet` API object.
+- Disable caching when fetching local snaps ([#227](https://github.com/MetaMask/snaps-monorepo/pull/227))
+  - This ensures that the `SnapController` will always fetch the latest snap manifest and source code during local development.
+
+### Removed
+- **BREAKING:** Remove the `PermissionController` and `SubjectMetadataController` ([#261](https://github.com/MetaMask/snaps-monorepo/pull/261))
+  - They are part of the [`@metamask/controllers`](https://npmjs.com/package/@metamask/controllers) as of version [26.0.0](https://github.com/MetaMask/controllers/releases/tag/v26.0.0) of that package.
+
+### Fixed
+- Prevent useless errors from being thrown when a snap is removed ([#215](https://github.com/MetaMask/snaps-monorepo/pull/215))
+
+## [0.9.0]
+### Added
+- Make `SnapController` npm registry configurable ([#200](https://github.com/MetaMask/snaps-monorepo/pull/200))
+
+### Changed
+- **BREAKING:** Return `null` from `SnapController.getSnapState` if the snap has no state ([#203](https://github.com/MetaMask/snaps-monorepo/pull/203))
+  - Previously it would return `undefined` in this case.
+- `@metamask/controllers@^25.1.0` ([#207](https://github.com/MetaMask/snaps-monorepo/pull/207))
+
+## [0.8.1]
+### Added
+- A variety of `SnapController` actions ([#199](https://github.com/MetaMask/snaps-monorepo/pull/199))
+
+## [0.8.0]
+### Added
+- Expose more `PermissionController` functionality via actions ([#194](https://github.com/MetaMask/snaps-monorepo/pull/194))
+
+### Changed
+- **BREAKING:** Replace `PermissionController` functions with actions in `SnapController` ([#194](https://github.com/MetaMask/snaps-monorepo/pull/194))
+
+## [0.7.0]
+### Changed
+- **BREAKING:** Rename execution environment service class and events ([#188](https://github.com/MetaMask/snaps-monorepo/pull/188))
+  - `ServiceMessenger` events are now named `ExecutionService`.
+  - `WebWorkerExecutionEnvironmentService` is now named `WebWorkerExecutionService`.
+
+## [0.6.3]
+### Fixed
+- Prevent `disableSnap` from throwing if the specified Snap is stopped ([#175](https://github.com/MetaMask/snaps-monorepo/pull/175))
+
+## [0.6.2]
+### Changed
+- **BREAKING:** Rename endowment permission builder exports ([#171](https://github.com/MetaMask/snaps-monorepo/pull/171))
+
+### Removed
+- **BREAKING:** Remove the `svgIcon` property from Snap state ([#172](https://github.com/MetaMask/snaps-monorepo/pull/172))
+  - The SVG icon content string is instead emitted with the `SnapController:snapAdded` event.
+
+## [0.6.1]
+### Changed
+- No changes this release.
+
+## [0.6.0]
+### Added
+- "Endowment" permissions ([#152](https://github.com/MetaMask/snaps-monorepo/pull/152))
+- `SnapController` endowment permissions support ([#155](https://github.com/MetaMask/snaps-monorepo/pull/155))
+- Network access endowment permission ([#154](https://github.com/MetaMask/snaps-monorepo/pull/154))
+- Snap installation events ([#162](https://github.com/MetaMask/snaps-monorepo/pull/162))
+
+### Changed
+- **BREAKING:** Refactor `SnapController` to support the new Snaps publishing specification ([#140](https://github.com/MetaMask/snaps-monorepo/pull/140), [#157](https://github.com/MetaMask/snaps-monorepo/pull/157), [#163](https://github.com/MetaMask/snaps-monorepo/pull/163))
+  - This introduces several breaking changes to how Snaps are developed, hosted, and represented at runtime. See [the specification](https://github.com/MetaMask/specifications/blob/d4a5bf5d6990bb5b02a98bd3f95a24ffb28c701c/snaps/publishing.md) and the referenced pull requests for details.
+- **BREAKING:** Rename Snap `name` property to `id` ([#147](https://github.com/MetaMask/snaps-monorepo/pull/147))
+- **BREAKING:** Introduce the required `permissionType` field to `PermissionController` permission specifications ([#152](https://github.com/MetaMask/snaps-monorepo/pull/152))
+- Make `SubjectMetadataController` subject metadata `name` optional ([#151](https://github.com/MetaMask/snaps-monorepo/pull/151))
+
+### Removed
+- **BREAKING:** Inline snap functionality ([#148](https://github.com/MetaMask/snaps-monorepo/pull/148))
+
+## [0.5.0]
+### Changed
+- **BREAKING:** Update restricted RPC methods per new `PermissionController` ([#143](https://github.com/MetaMask/snaps-monorepo/pull/143))
+- **BREAKING:** Convert all TypeScript `interface` declarations to `type` equivalents ([#143](https://github.com/MetaMask/snaps-monorepo/pull/143))
+- Bump `@metamask/obs-store` to `7.0.0` ([#144](https://github.com/MetaMask/snaps-monorepo/pull/144))
+
+## [0.4.0]
+### Added
+- `SubjectMetadataController` ([#61](https://github.com/MetaMask/snaps-monorepo/pull/61))
+- `PermissionController` ([#132](https://github.com/MetaMask/snaps-monorepo/pull/132), [#141](https://github.com/MetaMask/snaps-monorepo/pull/141))
+- **BREAKING:** `SnapController`: Add max request processing time ([#128](https://github.com/MetaMask/snaps-monorepo/pull/128))
+
+### Fixed
+- `SnapController`: Clean up timeouts after stopping a Snap ([#139](https://github.com/MetaMask/snaps-monorepo/pull/139))
+- `WebWorkerExecutionEnvironmentService`: Clean up post-termination timeouts ([#128](https://github.com/MetaMask/snaps-monorepo/pull/128))
+
+## [0.3.1]
+### Changed
+- **BREAKING:** Update Snap initial states ([#126](https://github.com/MetaMask/snaps-monorepo/pull/126))
+  - The `idle` status is now named `installing`, and rehydrated snaps will have the status `stopped`.
+
+### Fixed
+- Fix Snap execution and installation bugs ([#125](https://github.com/MetaMask/snaps-monorepo/pull/125))
+- Prevent Snaps from being started before installation is finished ([#124](https://github.com/MetaMask/snaps-monorepo/pull/124))
+- Correctly identify breaking changes in [0.3.0] release ([#123](https://github.com/MetaMask/snaps-monorepo/pull/123))
+
+## [0.3.0]
+### Added
+- Allow disabling and enabling Snaps ([#116](https://github.com/MetaMask/snaps-monorepo/pull/116))
+  - Only enabled Snaps can be started.
+- Start stopped Snaps that receive an RPC message ([#114](https://github.com/MetaMask/snaps-monorepo/pull/114))
+- Add Snap max idle time ([#105](https://github.com/MetaMask/snaps-monorepo/pull/105))
+  - A Snap that is idle for more than the max idle time will be stopped.
+- Poll Snaps for their status ([#104](https://github.com/MetaMask/snaps-monorepo/pull/104))
+  - If a Snap stops responding, it will be forced to stop.
+
+### Changed
+- **BREAKING:** Enforce consistent naming for Snaps-related functionality ([#119](https://github.com/MetaMask/snaps-monorepo/pull/119))
+- **BREAKING:** Use the `ControllerMessenger` to communicate between the `SnapController` and its execution environment service ([#100](https://github.com/MetaMask/snaps-monorepo/pull/100))
+
+## [0.2.2]
+### Added
+- Add Snap error state ([#96](https://github.com/MetaMask/snaps-monorepo/pull/96))
+
+### Fixed
+- Package script issues ([#97](https://github.com/MetaMask/snaps-monorepo/pull/97), [#98](https://github.com/MetaMask/snaps-monorepo/pull/98))
+
+## [0.2.0]
+### Changed
+- Update publish scripts ([#92](https://github.com/MetaMask/snaps-monorepo/pull/92))
+
+## [0.1.2]
+### Changed
+- Restore name of `handshake` method to `ping` ([#90](https://github.com/MetaMask/snaps-monorepo/pull/90))
+
+## [0.1.1]
+### Added
+- Out of band error support ([#88](https://github.com/MetaMask/snaps-monorepo/pull/88))
+
+### Changed
+- @metamask/controllers@17.0.0 ([#87](https://github.com/MetaMask/snaps-monorepo/pull/87))
+
+## [0.1.0]
+### Added
+- Readme file ([#71](https://github.com/MetaMask/snaps-monorepo/pull/71))
+
+### Changed
+- **BREAKING:** Rename package to `@metamask/snaps-controllers` ([#73](https://github.com/MetaMask/snaps-monorepo/pull/73))
+
+## [0.0.9]
+### Added
+- `PluginController`: Always persist plugin `isRunning` state as `false` ([#64](https://github.com/MetaMask/snaps-monorepo/pull/64))
+  - Plugins are not automatically running on boot, and we should never persist this state as `true`.
+
+### Changed
+- **BREAKING:** `@metamask/controllers@15.0.0` ([#66](https://github.com/MetaMask/snaps-monorepo/pull/66))
+  - This may cause incompatibilities with other versions of the `@metamask/controllers` package.
+
+## [0.0.7]
+### Fixed
+- Store plugin states in the correct place ([#48](https://github.com/MetaMask/snaps-monorepo/pull/48))
+  - Previously, plugin states would be set as top-level keys of the `PluginController`'s state. This broke retrieving plugin states. They are now correctly stored under `state.pluginStates`.
+
+## [0.0.6]
+### Added
+- iframe execution environment ([#33](https://github.com/MetaMask/snaps-monorepo/pull/33))
+- Execution environment OpenRPC spec ([#23](https://github.com/MetaMask/snaps-monorepo/pull/23))
+
+### Changed
+- **BREAKING:** Migrate `CommandEngine` message format to JSON-RPC ([#11](https://github.com/MetaMask/snaps-monorepo/pull/11))
+- **BREAKING:** Refactor `PluginController` to use `BaseControllerV2` ([#13](https://github.com/MetaMask/snaps-monorepo/pull/13))
+- **BREAKING:** Use generic execution environment interface ([#19](https://github.com/MetaMask/snaps-monorepo/pull/19))
+- **BREAKING:** Restore origin parameter to `setupWorkerConnection`, rename to `setupPluginProvider` ([#20](https://github.com/MetaMask/snaps-monorepo/pull/20))
+- **BREAKING:** Rename some execution environment methods ([#23](https://github.com/MetaMask/snaps-monorepo/pull/23))
+
+### Fixed
+- Ensure that the plugin `isRunning` check always runs when a plugin is started ([#21](https://github.com/MetaMask/snaps-monorepo/pull/21))
+
+## [0.0.5]
+### Added
+- First semi-stable release.
+
+[Unreleased]: https://github.com/MetaMask/snaps-monorepo/compare/v0.33.1-flask.1...HEAD
+[0.33.1-flask.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.33.0-flask.1...v0.33.1-flask.1
+[0.33.0-flask.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.32.2...v0.33.0-flask.1
+[0.32.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.32.1...v0.32.2
+[0.32.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.32.0...v0.32.1
+[0.32.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.31.0...v0.32.0
+[0.31.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.30.0...v0.31.0
+[0.30.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.29.0...v0.30.0
+[0.29.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.28.0...v0.29.0
+[0.28.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.27.1...v0.28.0
+[0.27.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.27.0...v0.27.1
+[0.27.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.26.2...v0.27.0
+[0.26.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.26.1...v0.26.2
+[0.26.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.26.0...v0.26.1
+[0.26.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.25.0...v0.26.0
+[0.25.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.24.1...v0.25.0
+[0.24.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.24.0...v0.24.1
+[0.24.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.23.0...v0.24.0
+[0.23.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.22.3...v0.23.0
+[0.22.3]: https://github.com/MetaMask/snaps-monorepo/compare/v0.22.2...v0.22.3
+[0.22.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.22.1...v0.22.2
+[0.22.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.22.0...v0.22.1
+[0.22.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.21.0...v0.22.0
+[0.21.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.20.0...v0.21.0
+[0.20.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.19.1...v0.20.0
+[0.19.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.19.0...v0.19.1
+[0.19.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.18.1...v0.19.0
+[0.18.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.18.0...v0.18.1
+[0.18.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.17.0...v0.18.0
+[0.17.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.16.0...v0.17.0
+[0.16.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.15.0...v0.16.0
+[0.15.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.14.0...v0.15.0
+[0.14.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.13.0...v0.14.0
+[0.13.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.12.0...v0.13.0
+[0.12.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.11.1...v0.12.0
+[0.11.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.11.0...v0.11.1
+[0.11.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.7...v0.11.0
+[0.10.7]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.6...v0.10.7
+[0.10.6]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.5...v0.10.6
+[0.10.5]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.3...v0.10.5
+[0.10.3]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.2...v0.10.3
+[0.10.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.1...v0.10.2
+[0.10.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.10.0...v0.10.1
+[0.10.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.8.1...v0.9.0
+[0.8.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.6.3...v0.7.0
+[0.6.3]: https://github.com/MetaMask/snaps-monorepo/compare/v0.6.2...v0.6.3
+[0.6.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.6.1...v0.6.2
+[0.6.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.2.2...v0.3.0
+[0.2.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.2.0...v0.2.2
+[0.2.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/MetaMask/snaps-monorepo/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/MetaMask/snaps-monorepo/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/MetaMask/snaps-monorepo/compare/v0.0.9...v0.1.0
+[0.0.9]: https://github.com/MetaMask/snaps-monorepo/compare/v0.0.7...v0.0.9
+[0.0.7]: https://github.com/MetaMask/snaps-monorepo/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/MetaMask/snaps-monorepo/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/MetaMask/snaps-monorepo/releases/tag/v0.0.5

package/dist/services/{offscreen/OffscreenPostMessageStream.d.ts → ProxyPostMessageStream.d.ts}

@@ -1,35 +1,35 @@
 import { BasePostMessageStream } from '@metamask/post-message-stream';
 import { JsonRpcRequest } from '@metamask/utils';
-export declare type OffscreenPostMessageStreamArgs = {
+export declare type ProxyPostMessageStreamArgs = {
     stream: BasePostMessageStream;
     jobId: string;
-    frameUrl: string;
+    extra?: Record<string, unknown>;
 };
-export declare type OffscreenPostMessage = {
+export declare type ProxyPostMessage = {
     jobId: string;
     data: JsonRpcRequest;
+    extra?: Record<string, unknown>;
 };
 /**
  * A post message stream that wraps messages in a job ID, before sending them
  * over the underlying stream.
  */
-export declare class OffscreenPostMessageStream extends BasePostMessageStream {
+export declare class ProxyPostMessageStream extends BasePostMessageStream {
     #private;
     /**
-     * Initializes a new `OffscreenPostMessageStream` instance.
+     * Initializes a new `ProxyPostMessageStream` instance.
      *
      * @param args - The constructor arguments.
      * @param args.stream - The underlying stream to use for communication.
      * @param args.jobId - The ID of the job this stream is associated with.
-     * @param args.frameUrl - The URL of the frame to load inside the offscreen
-     * document.
+     * @param args.extra - Extra data to include in the post message.
      */
-    constructor({ stream, jobId, frameUrl }: OffscreenPostMessageStreamArgs);
+    constructor({ stream, jobId, extra }: ProxyPostMessageStreamArgs);
     /**
      * Write data to the underlying stream. This wraps the data in an object with
      * the job ID.
      *
      * @param data - The data to write.
      */
-    _postMessage(data: OffscreenPostMessage): void;
+    _postMessage(data: ProxyPostMessage): void;
 }